@database MagicCX.guide @Master MCX10Eng.texinfo @Width 72 This is the AmigaGuide file MagicCX.guide, produced by Makeinfo-1.55 from the input file MCX10Eng.texinfo. @Node Main "MagicCX.guide" @Next "Welcome" MagicCX THE definite commodity/system enhancer for the Amiga running OS 2.0 and up (C) Copyright 1994 Kai Iske *** MagicCX is an SASG product *** - Shareware - Welcome to @{b}MagicCX@{ub} v1.0. So you finally made it into the documentation. I hope you like this program as much as I do and many other users. For any requests and suggestions just contact me under the address given in that document. Within this manual I will refer to the original program texts, that means not to the localized version of @{b}MagicCX@{ub}. I will explain all the steps necessary to install @{b}MagicCX@{ub} and use it. So read on and read carefully. Introduction @{" Welcome " Link "Welcome"} Welcome to MagicCX @{" Features " Link "Features"} A small feature list @{" Installation " Link "Installation"} How to install MagicCX and how to set it up @{" Quick Start " Link "Quick Start"} For those who just can`t wait A bit more serious @{" The concept " Link "The concept"} The concept behind MagicCX @{" Basic usage " Link "Basic usage"} Some notes about basic usage (Including mcxgui.library) @{" The Server Program " Link "The Server Program"} What about the server? @{" The Preferences Program " Link "The Preferences Program"} How to use the Preferences editor @{" Modules Manager " Link "Modules Manager"} For users of OS 3.x and up @{" The Modules " Link "The Modules"} Description of modules and their editors in the Preferences program Miscellaneous @{" Legal things " Link "Legal things"} Legal mumbo-jumbo @{" Registration " Link "Registration"} How to register @{" Updates " Link "Updates"} How to obtain updates @{" Bugreports " Link "Bugreports"} Where to send bugreports to? @{" Important addresses " Link "Important addresses"} The author`s address and the registration sites @{" Internals " Link "Internals"} Some internals of MagicCX @{" Configuration requirements " Link "Configuration requirements"} Minimum Hard- and Software @{" Some hints " Link "Some hints"} Hints for the users @{" Thanks-Credits " Link "Thanks-Credits"} Whom I must say 'Thank you' @EndNode @Node "Welcome" "MagicCX.guide/Welcome" @Next "Features" @Prev "Main" @Toc "Main" Welcome ******* Welcome to @{b}MagicCX@{ub}. So you really managed it. You got into this documentation. Well, not that bad at all. I strongly recommend to read this manual carefully as it covers all the bits and pieces of @{b}MagicCX@{ub}. Please keep in mind that I did not write this manual just for fun. I know what the program does and how to use it. This manual is for @{b}you@{ub}, the user. Read it and love it. It will aid you in understanding @{b}MagicCX@{ub} and the way it is used. @{b}Kai Iske@{ub} @EndNode @Node "Features" "MagicCX.guide/Features" @Next "Installation" @Prev "Welcome" @Toc "Main" Features ******** Here is a small feature list of @{b}MagicCX@{ub}. Some of the features mentioned might not sound that outstanding to you, while some others do. Read the list to have a quick overview what @{b}MagicCX@{ub} offers. @{b}*@{ub} Fully OS 2.0 compatible thus giving the Look and Feel @{b}*@{ub} Fully localized when running OS @{b}2.1@{ub}! @{b}*@{ub} @{b}MagicCX@{ub} will install itself as a commodity, so you may use all the convenient things offered by commodities. @{b}*@{ub} All new concept. Complex module features. @{b}MagicCX@{ub} is expandable using modules. You can configure @{b}MagicCX@{ub} to your needs. Only those features used will be loaded. @{b}*@{ub} Modules required/used will be installed in a directory @{b}Modules@{ub}. This is somewhat the same concept as Workbench uses it for device drivers, printers and such. If you want to use a module, move it to the appropriate directory. If not, move it to a storage directory. @{b}*@{ub} Modular Blanker concept, with two internal blanker types. @{b}MagicCX`s@{ub} blankers are expandable, too. @{b}*@{ub} For users of OS 3.0 and up there is a Modules Manager available to install/deinstall modules with ease. No need to use Workbench in order to move modules around. @{b}*@{ub} @{b}MagicCX@{ub} is split up into many different parts. The Server program, which serves as the main "control panel". It will utilize installed modules. The Preferences Editor, to set up @{b}MagicCX@{ub} to your needs. @{b}*@{ub} @{b}MagicCX@{ub} utilizes a great gadget layout engine, written by Olaf 'Olsen' Barthel to give you the best in window layout. Fully font sensitive and shortcut driven windows are the result @{b}*@{ub} Plenty of modules users may choose from in order to give them the best. @EndNode @Node "Installation" "MagicCX.guide/Installation" @Next "Quick Start" @Prev "Features" @Toc "Main" Installing MagicCX ****************** Here are some topics about the installation procedure @{" Installing with Installer " Link "Installing with Installer"} How to use the CBM Installer-Script @{" Using ToolTypes " Link "Using ToolTypes"} How to use ToolTypes @{" Using Shell parameters " Link "Using Shell parameters"} How to use Shell parameters @{" AppIcon and AppMenuItem " Link "AppIcon and AppMenuItem"} What about AppIcons/MenuItems ? @EndNode @Node "Installing with Installer" "MagicCX.guide/Installing with Installer" @Next "Using ToolTypes" @Prev "Installation" @Toc "Installation" Installing with Installer ========================= First, simply double-click on one of the files located in the @{b}Install-MagicCX@{ub} drawer, according to the language you want to use for the installation procedure. There is not too much to say about how to install @{b}MagicCX@{ub} using Installer. Simply follow the steps. Help is available almost everywhere. After installation there should be a directory somewhere in your directory tree containing the following files (or even some of them according to your installation) @{b}*@{ub} @{b}Server@{ub} This directory contains the Server program @{b}*@{ub} @{b}Prefs@{ub} This directory contains the Preferences program @{b}*@{ub} @{b}libs@{ub} Here you find @{b}mcx.library@{ub} for normal @{b}MagicCX@{ub} support functions and @{b}mcxgui.library@{ub} the layout engine (This is a cut down version of Olaf Barthel`s gtlayout.library). @{b}*@{ub} @{b}WBStartUp@{ub} This drawer contains a project icon to use for your @{b}SYS:WBStartUp@{ub} drawer. This icon may be used to launch @{b}MagicCX@{ub} at boot time @{b}*@{ub} @{b}Rexx@{ub} Contains the example ARexx Scripts for use with the Revision Control System @{b}*@{ub} @{b}Tools@{ub} Contains the Registration program @{b}Register@{ub} and the Modules Manager, as well as the RCS2HST program. @{b}*@{ub} @{b}Docs@{ub} Contains the documentation for @{b}MagicCX@{ub} @EndNode @Node "Using ToolTypes" "MagicCX.guide/Using ToolTypes" @Next "Using Shell parameters" @Prev "Installing with Installer" @Toc "Installation" Using ToolTypes =============== @{b}MagicCX`s@{ub} Server program knows some ToolTypes which can either be located within the .info file or may be issued on the command line. The syntax should be of the form @{b}ToolType=Value@{ub}. If you start the program from a command line you can leave out the `=' and replace it by a space. These ToolTypes have to be placed in the Server program`s icon, or in the WBStartUp default Project icon, depending on where you launch @{b}MagicCX@{ub} from. Here are the ToolTypes the program recognizes. @{b}@{b}DONOTWAIT@{ub}@{ub} This ToolType should be set for the WBStartUp Project icon, so that Workbench does not wait for @{b}MagicCX@{ub} to return. @{b}@{b}CX_PRIORITY=n@{ub}@{ub} Sets the priority for the program`s section which controls the HotKeys. If you issue a priority > 0 it may be that HotKeys initialized by other programs may not be reached anymore if @{b}MagicCX@{ub} uses the same. Default: It`s neutral @{b}0@{ub}. @{b}@{b}CX_POPKEY=s@{ub}@{ub} Lets you define a new HotKey for opening @{b}MagicCX`s@{ub} main window. Default: @{b}LCOMMAND HELP@{ub}. @{b}@{b}CX_POPUP=YES|NO@{ub}@{ub} You can choose whether the main window should be opened on startup or not. Issuing @{b}YES@{ub} will open the window whilst @{b}NO@{ub} will keep it away. Default: @{b}YES@{ub}. @{b}@{b}PORTNAME=s@{ub}@{ub} You can select a different name for the program`s ARexx-Port. Please remember that this name`s length should not exceed 16 chars and that the name is case-sensitive. Normally this will be @{b}MCX@{ub}. @{b}@{b}NOICON@{ub}@{ub} This simple ToolType tells @{b}MagicCX@{ub} not to generate the AppIcon on the Workbench. See @{"AppIcon and AppMenuItem" Link "AppIcon and AppMenuItem"}, for more information on AppIcons and AppMenuItems. @{b}@{b}NOMENU@{ub}@{ub} If you do not want to have the AppMenuItem, too, use this ToolType. (see @{"AppIcon and AppMenuItem" Link "AppIcon and AppMenuItem"}). @{b}@{b}ICONX=n@{ub}@{ub} Using this ToolType you may specify the AppIcon`s X-Position. Default setting is that the Workbench should find a suitable location. @{b}@{b}ICONY=n@{ub}@{ub} Same as above, with only one exeception. This ToolType controls the AppIcon`s Y-Position on the Workbench Screen. @EndNode @Node "Using Shell parameters" "MagicCX.guide/Using Shell parameters" @Next "AppIcon and AppMenuItem" @Prev "Using ToolTypes" @Toc "Installation" Using Shell parameters ====================== You can supply parameters to @{b}MagicCX`s@{ub} Server program when starting from a CLI/SHELL. The name and function of each parameter is the same as already described in the previous section (see @{"Using ToolTypes" Link "Using ToolTypes"}). @EndNode @Node "AppIcon and AppMenuItem" "MagicCX.guide/AppIcon and AppMenuItem" @Prev "Using Shell parameters" @Toc "Installation" AppIcon and AppMenuItem ======================= If not chosen differently, when started, @{b}MagicCX@{ub} will display an AppIcon on the Workbench screen. This icon does not have anything to do with @{b}normal@{ub} Worbench icons. These stand for programs which can be started by a double-click on the corresponding icon which is defined within the program`s .info file. An AppIcon is a so called Applications Icon. This type of icon is generated by programs from which the user may communicate with the program. For @{b}MagicCX@{ub} the AppIcon only has one function: A double-click on the icon will open up the main window. Furthermore @{b}MagicCX@{ub} will generate an AppMenuItem which is appended to the @{b}Tools@{ub} menu of the Workbench. Each program can add one (or more) entries to that menu. The method of selecting one of these entries is the same as for "normal" menus. @{b}MagicCX@{ub} will add a menu entry called @{b}MCX Preferences@{ub} from which you can open the program`s main window. @EndNode @Node "Quick Start" "MagicCX.guide/Quick Start" @Next "The concept" @Prev "Installation" @Toc "Main" Quick Start *********** After installing @{b}MagicCX@{ub} you may either reboot your system in order to start @{b}MagicCX@{ub} or simply double-click on the Server program`s icon. @{b}MagicCX@{ub} will then utilize the default settings, so you may go with @{b}MagicCX@{ub} (see @{"Installation" Link "Installation"}). If the Project icon has been installed to WBStartUp, @{b}MagicCX@{ub} will be launched every time you boot your system. This behaviour can be changed by moving the Icon from WBStartUp to any other location. Using the Preferences Program (see @{"The Preferences Program" Link "The Preferences Program"}) you may alter the settings of @{b}MagicCX@{ub} and it`s modules. @EndNode @Node "The concept" "MagicCX.guide/The concept" @Next "Basic usage" @Prev "Quick Start" @Toc "Main" The concept *********** @{b}MagicCX`s@{ub} main goal is to give the user the best in flexibility and configurability. Flexibility is achieved through an all new modules mechanism first introduced by @{b}MagicCX@{ub} to the world of commdodities/system enhancers. These modules allow the user to select functions to use with @{b}MagicCX@{ub} thus giving her the best available opportunity to create a commodity which suits her needs. Configurability is achieved through an extremly user-friendly Preferences program, which does not lack any of the modern features any window oriented system should offer. Its font sensitive throughout any window. All gadgets are set with shortcuts. The clear and open design of all windows, gives the user all that he needs to configure the program with ease. @EndNode @Node "Basic usage" "MagicCX.guide/Basic usage" @Next "The Server Program" @Prev "The concept" @Toc "Main" Basic usage *********** - Concerning mcxgui.library there is one thing to say. Per default, the library will only be loaded when needed, ie. a module/program requires mcxgui.library, so it will load the library from disk, use it and when it is done, it will close the library again. If this module was the only one using the library, it will be removed from memory, thus reducing the amount of memory needed. If you want to have the library preloaded so that it won`t be loaded every time it is needed, simply set an environment variable called @{b}MCXPRELOADGUI@{ub} to something. It doesn`t matter what you set for this variable, it`s just that it must exist. - The Installation procedure will create a directory of your choice and assign @{b}MagicCX:@{ub} to it. You must not move or rename any parts of @{b}MagicCX@{ub} except for the modules/blankers, which can be moved around in order to disable/enable them. All libraries/programs should stay where the Installation procedure has placed them. - The file @{b}MagicCX@{ub} within the directory @{b}MagicCX:WBStartUp@{ub} can be moved to your @{b}SYS:WBStartUp@{ub} directory in order to launch @{b}MagicCX@{ub} on startup. - If you want to use a module, move it to the @{b}MagicCX:Modules@{ub} drawer. If you want to use a blanker module move it to the @{b}MagicCX:Modules/Blankers@{ub} drawer. Modules/Blankers not used can be stored in the appropriate @{b}MagicCX:ModuleStorage@{ub} or @{b}MagicCX:ModuleStorage/Blankers@{ub} directories. Users of OS 3.x and up can use the file @{b}ModuleManager@{ub} located in @{b}MagicCX:Tools@{ub} to control modules/blankers (see @{"Modules Manager" Link "Modules Manager"}, for more information). - All of @{b}MagicCX`s@{ub} windows may be closed using the @{b}ESC@{ub} key - Some of @{b}MagicCX`s@{ub} Button gadgets have a second border drawn around them. These gadgets correspond to the @{b}RETURN@{ub} key - Most of the negative choices with @{b}MagicCX`s@{ub} windows correspond to the @{b}ESC@{ub} key, ie. negative gadgets can be controlled using @{b}ESC@{ub} - All gadgets can be controlled through their shortcuts - For the Preferences program`s main window: The Editors ListView can be controlled using the @{b}Cursor@{ub} keys - For other windows; Windows containing a single ListView: These ListViews can be controlled using the @{b}Cursor@{ub} keys as well - From within any of the Preferences Program`s windows, you may retrieve Onlinehelp by pressing the @{b}HELP@{ub} key. Only for the HotKeys windows it doesn`t work as all the keys pressed should be designated to HotKeys, not to opening an Online help. @EndNode @Node "The Server Program" "MagicCX.guide/The Server Program" @Next "The Preferences Program" @Prev "Basic usage" @Toc "Main" The Server program ****************** Well, there is not too much to say about the Server program. When launched, it will simply do nothing, except for watching/performing all the actions specified within the Preferences editor (see @{"The Preferences Program" Link "The Preferences Program"}, for more information about setting the prefs). On demand @{b}MagicCX@{ub} may also launch the Preferences editor either via HotKey, AppIcon or via the AppMenuItem (see @{"AppIcon and AppMenuItem" Link "AppIcon and AppMenuItem"}, for more about that). @{b}NOTE@{ub} to users of MagicMenu. Please make sure that you launch Magic Menu, before @{b}MagicCX@{ub}! While starting it from @{b}WBStartUp@{ub} you should set the STARTPRI ToolType to a somewhat higher value than that of MagicMenu. This is because MagicMenu also patches the OpenScreen() functions, which would conflict with @{b}MagicCX`s@{ub} window-reactivation and screen cycling. @EndNode @Node "The Preferences Program" "MagicCX.guide/The Preferences Program" @Next "Modules Manager" @Prev "The Server Program" @Toc "Main" The Preferences program *********************** Assuming, that you used the default installation for installing @{b}MagicCX@{ub} on your HardDisk/BootDisk I will now explain, how to use the Preferences program to set up @{b}MagicCX@{ub} to your needs. This program may be started either by @{b}MagicCX@{ub} or by simply double-clicking on it`s icon. Per default the program is located within @{b}MagicCX:Prefs@{ub}. This program is the main interface to @{b}MagicCX@{ub}, as it controls all the settings. Within the windows you will find gadgets (how come ?). All of the gadgets may be alternatively controlled via keyboard. To find out which key to use, simply take a look at the gadget`s text. There is a character underlined, which is the shortcut to use. The lower 4 gadgets are used to control @{b}MagicCX@{ub}. These are: @{b}*@{ub} @{b}Use@{ub} Will store the current settings in @{b}ENV:MagicCX/MCX_prefs.iff@{ub} @{b}*@{ub} @{b}Save@{ub} Will store the current settings in @{b}ENV:MagicCX/MCX_prefs.iff@{ub} @{b}and@{ub} @{b}ENV:MagicCX/MCX_prefs.iff@{ub} for permanent storage. @{b}*@{ub} @{b}Hide@{ub} Will close the Preferences editor. @{b}*@{ub} @{b}Quit@{ub} Will quit the Preferences editor @{b}and@{ub} the server program. The main window has a menu attached. @{b}*@{ub} @{b}Call ModulesManager...@{ub} Will launch the ModulesManager for you (see @{"Modules Manager" Link "Modules Manager"}). @{b}*@{ub} @{b}Hide@{ub} Same as the Hide gadget. @{b}*@{ub} @{b}About...@{ub} Will open the About-Requester. From within the About Requester you may launch the SASG Registration Program if you want to register for @{b}MagicCX@{ub} or update. @{b}*@{ub} @{b}Quit@{ub} Same as the Quit gadget At the left side of the main window you will find a ListView gadget containing all the pages for the various functions/installed modules. To the right of the window there will be the settings page for the function/subsystem selected from the ListView. @EndNode @Node "Modules Manager" "MagicCX.guide/Modules Manager" @Next "The Modules" @Prev "The Preferences Program" @Toc "Main" Modules Manager *************** The modules manager will aid you in installing/deinstalling modules/blankers you would like to use. Simply launch the Modules Manager located in @{b}MagicCX:Tools@{ub}. Simply start the modules manager and it will scan your @{b}MagicCX:Modules@{ub} and @{b}MagicCX:ModuleStorage@{ub} drawers to check for used/unused modules. You may select the modules to install/uninstall by selecting the entry and either clicking on the Checkbox gadget to the left or by hitting the Space key. Using the "Module type" gadget you may switch between Modules and Blankers. Hitting "Ok" will start the installation/deinstallation procedure. If an error occurs during installation, the Modules Manager will report it, but tries to continue with it`s work. Selecting "Cancel" will leave all modules/blankers untouched. @EndNode @Node "The Modules" "MagicCX.guide/The Modules" @Next "Legal things" @Prev "Modules Manager" @Toc "Main" The Modules *********** This sections covers the description of all modules and their editor pages within the Preferences program. Configurable modules @{" Alarm " Link "Alarm"} The alarm facility (external) @{" Analog Clock " Link "Analog Clock"} Special analog clock (external) @{" Blanking " Link "Blanking"} The internal blanking system @{" Calendar " Link "Calendar"} A special calendar (external) @{" Clock " Link "Clock"} The titlebar/window clock @{" Cycle to menu " Link "Cycle to menu"} Turn Cycle gadgets into popup menus (external) @{" Exploding Windows " Link "Exploding Windows"} Explode/Implode windows (external) @{" Formatter " Link "Formatter"} Disk watcher with auto formatting capability (external) @{" Function keys " Link "Function keys"} Define your own Function keys (external) @{" Grabber " Link "Grabber"} Grab/Print active screen/window (external) @{" HotKey definitions " Link "HotKey definitions"} Defining MagicCX`s Hotkeys @{" Hunt windows " Link "Hunt windows"} Hunt windows feature @{" Key Cycling " Link "Key Cycling"} Key window/screen cycling @{" Lock windows " Link "Lock windows"} Exclude windows from MagicCX`s window activation (external) @{" Miscellaneous 1 " Link "Miscellaneous 1"} Miscellaneous page 1 @{" Miscellaneous 2 " Link "Miscellaneous 2"} Miscellaneous page 2 @{" Mouse Cycling " Link "Mouse Cycling"} Mouse window/screen cycling @{" Mouse related " Link "Mouse related"} Mouse related features @{" MoveSizer " Link "MoveSizer"} Size/Move windows with any click (external) @{" Select Screen " Link "Select Screen"} Select a screen/window easily (external) @{" Special Cycling " Link "Special Cycling"} Special window cycling @{" TagScreens " Link "TagScreens"} Force old type screens to new ones (external) @{" Telephone Bill " Link "Telephone Bill"} Calculate telephone costs (external) @{" ToolAlias " Link "ToolAlias"} Substitute Default Projects (external) @{" Window related " Link "Window related"} Window related features Non configurable modules @{" ARexx " Link "ARexx"} The ARexx Port (including RCS module) (external) @{" AssignWedge " Link "AssignWedge"} Better "Please insert..." requesters (external) @{" UnixDirs " Link "UnixDirs"} Use ".."/"." on your system (external) @EndNode @Node "Alarm" "MagicCX.guide/Alarm" @Next "Analog Clock" @Prev "The Modules" @Toc "The Modules" The alarm facility ================== @{b}MagicCX@{ub} may alarm you at a given time with a given sound and text. It may even alarm at full hours/quarters or halfs of an hour. From within the Alarm page you may get to two more windows for setting up the alarm. @{" Configure alarm " Link "Configure alarm"} Configure the timed alarm @{" Configure by hour " Link "Configure by hour"} Configure by hour alarm @EndNode @Node "Configure alarm" "MagicCX.guide/Configure alarm" @Next "Configure by hour" @Prev "Alarm" @Toc "Alarm" Configuring the timed alarm --------------------------- This window will be used to set the timed alarm. You may use the following gadgets to configure the alarm. @{b}*@{ub} @{b}Alarm active@{ub} If set @{b}MagicCX@{ub} will check the system time for the alarmtime and alarm you if necessary. @{b}MagicCX@{ub} will then DisplayBeep() or play the specified sample. Furthermore it may show a requester with a user definable text. @{b}*@{ub} @{b}Alarm time@{ub} Use this gadget to set the alarmtime @{b}*@{ub} @{b}Show Requester@{ub} If set, @{b}MagicCX@{ub} will show a requester with the user supplied text. @{b}*@{ub} @{b}Requester text@{ub} Enter the text to display here. A special character string '\n' is used to set a linefeed, ie. if you want to seperate lines, simply enter '\n' @{b}*@{ub} @{b}Alarm mode@{ub} This gadget will determine the sound mode for the alarm. If set to 'DisplayBeep()' @{b}MagicCX@{ub} will simply beep and use the system preferences for the beep. If set to '8SVX-Sound', you may choose a sample to be played. @{b}*@{ub} @{b}Alarm sample@{ub} Simply enter the name of the sample to be played on an alarm. Please enter the complete path! @{b}*@{ub} @{b}Sample volume@{ub} Set the volume for the sample to be played on an alarm. '0' is the lowest volume, while '64' is the highest @{b}*@{ub} @{b}Test sample@{ub} Will play the sample for you with the given volume. @EndNode @Node "Configure by hour" "MagicCX.guide/Configure by hour" @Prev "Configure alarm" @Toc "Alarm" Configuring the by hour alarm ----------------------------- This window will be used to set the "by hour" alarm. If set, @{b}MagicCX@{ub} will alarm every full hour, or, if specified, every quarter or half an hour as well. Using the following gadgets you may configure the "by hour" alarm. @{b}*@{ub} @{b}Every hour@{ub} If set the "by hour" alarm is active. @{b}*@{ub} @{b}Period@{ub} Using this gadget you may configure @{b}MagicCX@{ub} when to alarm. - @{b}Hour@{ub} Single sound with full hours - @{b}Hour + Halfs@{ub} Single sound with half of hours, double sound with full hours - @{b}Hour + Quarters@{ub} Single sound with quarter of hours, double sound with full hours @{b}*@{ub} @{b}Hour mode@{ub} This gadget will be used to set the mode for the "by hour" sound. If set to 'DisplayBeep()' the system beep will be used. If set to '8SVX-Sound' @{b}MagicCX@{ub} will play the specified sample. @{b}*@{ub} @{b}Hour sample@{ub} Specify the sample to be played. Please include the complete path. @{b}*@{ub} @{b}Sample volume@{ub} Set the volume for the sample to be played on an alarm. '0' is the lowest volume, while '64' is the highest @{b}*@{ub} @{b}Test sample@{ub} Test the specified sample with the given volume. @EndNode @Node "Analog Clock" "MagicCX.guide/Analog Clock" @Next "Blanking" @Prev "Alarm" @Toc "The Modules" Special analog clock ==================== This is a great looking analog clock with plenty of possibilities. If active, @{b}MagicCX@{ub} will open a window you can drag around your Workbench. In the upper left corner of the window there is a standard close gadget. In the lower right corner of the window you will find a sizing gadget for sizing the window. Clicking in the center of the window will enable you to drag around the window. Even though these gadgets are not visible, they are there. The gadgets on this page either configure the clock or lead to other windows with more gadgets for configuring the clock. @{b}*@{ub} @{b}Analog clock active@{ub} If set, the analog clock will be displayed on the default public screen @{b}*@{ub} @{b}Settings@{ub} Will bring you to the settings window for the analog clock. See @{"Settings" Link "Analog clock settings"}. @{b}*@{ub} @{b}Hand colors@{ub} Will bring you to a window from which you may define the colors of the clock`s hands. See @{"Hand colors" Link "Analog clock Hand colors"}. @{b}*@{ub} @{b}Background colors@{ub} Will bring you to a window from which you may define the background colors of the analog clock. See @{"Background colors" Link "Analog clock Background colors"}. @{b}*@{ub} @{b}Pattern type@{ub} You may choose from four different background pattern types: - @{b}Solid@{ub} A single color pattern - @{b}4x4 Pattern@{ub} A Pattern set up by four different colors - @{b}ILBM Picture@{ub} This one is only available under OS 3.x. It gives you the possibility to select a picture to be used as background of the analog clock. - @{b}ILBM Picture remapped@{ub} This one is only available under OS 3.x. It gives you the possibility to select a picture to be used as background of the analog clock. The only difference to the options above is that the colors of the background image will be remapped to the screen`s colors to give you best results @{b}*@{ub} @{b}Pattern colors@{ub} Only available if either 'Solid' or '4x4 Pattern' is set. Will bring you to a window from which you may define the pattern colors. See @{"Pattern colors" Link "Analog clock Pattern colors"}. @{b}*@{ub} @{b}Picture name@{ub} Only available under OS 3.x. You may select the name of a picture to be used as background for the analog clock @EndNode @Node "Analog clock settings" "MagicCX.guide/Analog clock settings" @Next "Analog clock Hand colors" @Prev "Analog Clock" @Toc "Analog Clock" Analog clock settings --------------------- Control various settings of the analog clock using these gadgets. @{b}*@{ub} @{b}Window always in front@{ub} Will cause @{b}MagicCX@{ub} to bring the analog clock to front as soon as another window is placed in front of the window and overlaps it. @{b}*@{ub} @{b}Show seconds@{ub} Show seconds hand @{b}*@{ub} @{b}Oval@{ub} Show oval marks on background @{b}*@{ub} @{b}High noon same size@{ub} Per default the 0/12 hour mark will be drawn slightly bigger than the quarter marks. Using this gadget you may tell @{b}MagicCX@{ub} to draw the mark the same size as the other marks @{b}*@{ub} @{b}Show@{ub} Let`s you specify which marks to show - @{b}Minutes@{ub} Show all marks including minutes - @{b}Hours@{ub} Show only hour marks - @{b}Quarters@{ub} Show only quarter marks - @{b}One@{ub} Only high noon mark will be drawn - @{b}None@{ub} No marks will be drawn at all @{b}*@{ub} @{b}Hand style@{ub} This gadget determines the style of the minute/hour hands. You may select from : Line, Triangle, Rhombus, and Rectangle @{b}*@{ub} @{b}Hand size@{ub} This gadget determines the size of the minute/hour hands. Sizes supported are: Very thin, Thin, Normal, Thick, Very thick @{b}*@{ub} @{b}Draw shadow@{ub} Draw a shadow below minute/hour hands @{b}*@{ub} @{b}Border style@{ub} The window may either have "None", a "Single" border or a "Double" border @{b}*@{ub} @{b}Border hires/Border interlace@{ub} Using these gadgets you may determine the size of a "Double" border @EndNode @Node "Analog clock Hand colors" "MagicCX.guide/Analog clock Hand colors" @Next "Analog clock Background colors" @Prev "Analog clock settings" @Toc "Analog Clock" Analog clock hand colors ------------------------ This window contains the entries for the analog clock`s hand colors. @{b}*@{ub} @{b}Seconds@{ub} The color for the seconds hand @{b}*@{ub} @{b}Minute@{ub} The minute hand`s color @{b}*@{ub} @{b}Minute border@{ub} The minute hand`s border color @{b}*@{ub} @{b}Hour@{ub} The hour hand`s color @{b}*@{ub} @{b}Hour border@{ub} The hour hand`s border color @{b}*@{ub} @{b}Shadow@{ub} The shadow color for minute/hour hands @EndNode @Node "Analog clock Background colors" "MagicCX.guide/Analog clock Background colors" @Next "Analog clock Pattern colors" @Prev "Analog clock Hand colors" @Toc "Analog Clock" Analog clock background colors ------------------------------ From within this window you may set the colors to use for the marks and borders. @{b}*@{ub} @{b}High noon@{ub} Set the color for the high noon mark @{b}*@{ub} @{b}Quarter@{ub} Set the color for quarter marks @{b}*@{ub} @{b}Hours@{ub} Set the color for hour marks @{b}*@{ub} @{b}Minutes@{ub} Set the color for minute marks @{b}*@{ub} @{b}Border fill inactive@{ub} Set the color of the "double" border when window is inactive @{b}*@{ub} @{b}Border shine@{ub} Set the shine color for the window`s border @{b}*@{ub} @{b}Border shadow@{ub} Set the shadow color for the window`s border @{b}*@{ub} @{b}Border fill active@{ub} Set the color of the "double" border when window is active @EndNode @Node "Analog clock Pattern colors" "MagicCX.guide/Analog clock Pattern colors" @Prev "Analog clock Background colors" @Toc "Analog Clock" Analog clock pattern colors --------------------------- This window is used for setting the colors of "Solid" and "4x4 Pattern" type patterns. For the "Solid" type, there will be only the first entry of the ones mentioned below. Pattern1-Pattern4 will set the colors for each color entry of the pattern @EndNode @Node "Blanking" "MagicCX.guide/Blanking" @Next "Calendar" @Prev "Analog Clock" @Toc "The Modules" The internal blanking system ============================ @{b}MagicCX@{ub} offers a screen/mouse blanker system with several features. The Blanking page shows all the main settings for the blanking system @{b}*@{ub} @{b}Screen blanker@{ub} If set, @{b}MagicCX@{ub} will blank the screen after "Screen time" @{b}*@{ub} @{b}Screen time@{ub} Set the timeout for the screen blanking. @{b}*@{ub} @{b}Unblank with@{ub} Using this gadget you may tell @{b}MagicCX@{ub} which actions trigger an unblanking of a screen. Per default you may use the Mouse, Keyboard, Joystick, or insert-a-disk in order to unblank the screen. Select one of the combinations listed. @{b}*@{ub} @{b}Advanced@{ub} Will bring you to another window with advanced screen blanking settings. See @{"Advanced Blanking" Link "Advanced Blanking"}. @{b}*@{ub} @{b}Mouse blanker@{ub} If set, @{b}MagicCX@{ub} will blank the mouse after "Mouse time". It will be unblanked as soon as you move your mouse. @{b}*@{ub} @{b}Mouse time@{ub} Set the timeout for the mouse blanking @{b}*@{ub} @{b}Blank on keystroke@{ub} If you want to blank the mouse with a keystroke, check this gadget. As soon as you hit a key on your keyboard the mouse will be blanked. @EndNode @Node "Advanced Blanking" "MagicCX.guide/Advanced Blanking" @Prev "Blanking" @Toc "Blanking" Advanced screen blanking ------------------------ From within this window you may set advanced topics of the screen blanker, including the external blanker modules. @{b}*@{ub} @{b}No blank with carrier@{ub} Tells @{b}MagicCX@{ub} not to blank the screen while having a carrier, ie. while being connected to a mailbox using a Modem or such, regardless of the screen timeout set for the screen blanker. This option is only available when the PhoneBill.mcxmod module is installed. @{b}*@{ub} @{b}Blanker type@{ub} Choose a blanker type. - @{b}Blanker@{ub} Standard internal blanker. Will simply blank the screen - @{b}Dimmer@{ub} Standard internal dimmer. Will darken visible screens by the percentage specifed for the dimmer. - @{b}External module@{ub} Will enable the remaining gadgets, so you may specify/configure an external blanker module. For a list of external modules refer to @{"Blanker Modules" Link "Blanker Modules"}. - @{b}External module at random@{ub} Will grab a blanker module (if installed) randomly and use it, every time the screen should be blanked @{b}*@{ub} @{b}Dimming@{ub} Set the dimming factor for the internal screen dimmer. This is a percentage for the amount of dimming the screencolors. @{b}*@{ub} @{b}External module@{ub} Select a new external blanker module from the modules installed. @{b}*@{ub} @{b}Blanker task priority@{ub} Sets the priority for an external blanker @{b}*@{ub} @{b}Screen Mode@{ub} Some blankers open their own screens. You may choose a screen mode for such modules using this gadget @{b}*@{ub} @{b}Configure mode@{ub} If a blanker module offers the possibility to be configured by the user, this gadget will open the module`s preferences window. As the preferences offered for a Blanker module aren`t too complex, I won`t explain evey editor in detail here. They are somehow self-explantory. Play around with the Blanker`s settings. @EndNode @Node "Blanker Modules" "MagicCX.guide/Blanker Modules" @Prev "Advanced Blanking" @Toc "Advanced Blanking" The Blanker Modules ------------------- The Blanker Modules were written by Frank Mariak. Many thanks to him for doing this. The Blanker Modules currently available for @{b}MagicCX@{ub} are: @{b}*@{ub} @{b}Fractals@{ub} This module will draw fractals on the screen. @{b}*@{ub} @{b}Interference@{ub} This module will draw interference shapes and will color cycle them. @{b}*@{ub} @{b}Life@{ub} A simple module, which will "play" the game of Life. @{b}*@{ub} @{b}LineDawn@{ub} Will take the frontmost screen and clear it by drawing lines. @{b}*@{ub} @{b}Plasma@{ub} This module will draw Plasma style backgrounds and color cycle them. @{b}*@{ub} @{b}Puzzle@{ub} Will take the frontmost screen and shift pieces as with a puzzle. @{b}*@{ub} @{b}Stars@{ub} Stars coming out of your monitor. @{b}*@{ub} @{b}Worms@{ub} Will take the frontmost screen and start drawing "worms" on it, which eat up the background. @EndNode @Node "Calendar" "MagicCX.guide/Calendar" @Next "Clock" @Prev "Blanking" @Toc "The Modules" A special calendar ================== This is a fancy looking calendar with plenty of possibilities. If active, @{b}MagicCX@{ub} will open a window you can drag around your Workbench. In the upper left corner of the window there is a standard close gadget. In the lower right corner of the window you will find a sizing gadget for sizing the window. Clicking in the center of the window will enable you to drag around the window. Even though these gadgets are not visible, they are there. @{b}*@{ub} @{b}Calendar active@{ub} Tell @{b}MagicCX@{ub} whether to display the calendar or not @{b}*@{ub} @{b}Settings@{ub} Enter the advanced settings for the calendar. See @{"Calendar settings" Link "Calendar Settings"}. @{b}*@{ub} @{b}Colors@{ub} Enter the color settings window for the calendar. See @{"Calendar colors" Link "Calendar colors"}. @{b}*@{ub} @{b}Pattern type@{ub} You may choose from four different background pattern types: - @{b}Solid@{ub} A single color pattern - @{b}4x4 Pattern@{ub} A Pattern set up by four different colors - @{b}ILBM Picture@{ub} This one is only available under OS 3.x. It gives you the possibility to select a picture to be used as background of the calendar. - @{b}ILBM Picture remapped@{ub} This one is only available under OS 3.x. It gives you the possibility to select a picture to be used as background of the analog clock. The only difference to the options above is that the colors of the background image will be remapped to the screen`s colors to give you best results @{b}*@{ub} @{b}Pattern colors@{ub} Only available if either 'Solid' or '4x4 Pattern' is set. Will bring you to a window from which you may define the pattern colors. See @{"Calendar pattern colors" Link "Calendar Pattern colors"}. @{b}*@{ub} @{b}Picture name@{ub} Only available under OS 3.x. You may select the name of a picture to be used as background for the calendar @EndNode @Node "Calendar Settings" "MagicCX.guide/Calendar Settings" @Next "Calendar colors" @Prev "Calendar" @Toc "Calendar" Calendar settings ----------------- From within this window you may configure the look and "taste" of the calendar. There are plenty of settings you might already know from the Analog Clock. @{b}*@{ub} @{b}Window always in front@{ub} Will cause @{b}MagicCX@{ub} to bring the calendar to front as soon as another window is placed in front of the window and overlaps it. @{b}*@{ub} @{b}Display mode@{ub} You may choose from three different draw modes for the calendar. The default mode is "2D" and will only display a single sheet with the month/day information on. The "3D" mode is somewhat more distinguished as it shows a calendar with styled papers behind and the first paper is somewhat bend. "Plain" is the simplest of all. It will simply display the information surrounded by a rectangle. @{b}*@{ub} @{b}Border size@{ub} Set the size of the 3D Border (paper) depth @{b}*@{ub} @{b}Day/Month information@{ub} You can tell @{b}MagicCX@{ub} which information to display on the calendar. You may either have "Day + Month", only "Day", only "Month" or even "None" @{b}*@{ub} @{b}Border style@{ub} The window may either have "None", a "Single" border or a "Double" border @{b}*@{ub} @{b}Border hires/Border interlace@{ub} Using these gadgets you may determine the size of a "Double" border @{b}*@{ub} @{b}Digit font/Text font@{ub} Select the fonts to use for the digit and month texts @EndNode @Node "Calendar colors" "MagicCX.guide/Calendar colors" @Next "Calendar Pattern colors" @Prev "Calendar Settings" @Toc "Calendar" Calendar colors --------------- Using this window, you may configure the colors used by the calendar. @{b}*@{ub} @{b}Paper color@{ub} The color used for rendering the paper, the digits will be drawn on. @{b}*@{ub} @{b}Digit color@{ub} The color for rendering the digit text @{b}*@{ub} @{b}Day color@{ub} Color for rendering day informations @{b}*@{ub} @{b}Month color@{ub} Color for rendering month informations @{b}*@{ub} @{b}Paper border color@{ub} The color used for rendering the lower right corner of the "2D" calendar and the color for rendering the trim bar of the "3D" calendar. Furthermore, this color will be used to draw the "Plain" rectangle. @{b}*@{ub} @{b}Border fill inactive@{ub} Set the color of the "double" border when window is inactive @{b}*@{ub} @{b}Border shine@{ub} Set the shine color for the window`s border @{b}*@{ub} @{b}Border shadow@{ub} Set the shadow color for the window`s border @{b}*@{ub} @{b}Border fill active@{ub} Set the color of the "double" border when window is active @EndNode @Node "Calendar Pattern colors" "MagicCX.guide/Calendar Pattern colors" @Prev "Calendar colors" @Toc "Calendar" Calendar pattern colors ----------------------- This window is used for setting the colors of "Solid" and "4x4 Pattern" type patterns. For the "Solid" type, there will be only the first entry of the ones mentioned below. Pattern1-Pattern4 will set the colors for each color entry of the pattern @EndNode @Node "Clock" "MagicCX.guide/Clock" @Next "Cycle to menu" @Prev "Calendar" @Toc "The Modules" The titlebar/window clock ========================= @{b}MagicCX@{ub} can render time/memory and other informations in the upper right corner of a screen, ie. the right side of a screen`s titlebar. Several modes and settings are available. Furthermore you may choose from several default pages (predefined combinations) to be displayed. The time/memory display may alternatively be displayed in a window which will open up on the default public screen. You may drag around this window to any place you like. The clock supports several different pages with different formats. There are 7 pages available on any system. Starting with OS 2.1 and locale.library you may even have eight different pages. You can flip through those pages using a HotKey (see @{"HotKey definitions" Link "HotKey definitions"}). - @{b}Time@{ub} Display time information only - @{b}Time + memory@{ub} Display time information and memory free information together. Memory information is split up into Chip and Fast memory shown in KBytes. - @{b}Time + gauge@{ub} Display time information and a memory gauge, graphically showing free memory. - @{b}ChipMem and FastMem@{ub} Display free Chip and Fast memory in Bytes. - @{b}Complete memory@{ub} Display complete free memory in Bytes - @{b}Gauge memory@{ub} Only display memory gauge - @{b}Connect time@{ub} Display information about current connect. (This is for the Telephone bill module, See @{"Telephone Bill" Link "Telephone Bill"}.) - @{b}User definable page@{ub} Starting with OS 2.1 and locale.library you may have a user definable page. Setable through a String gadget using tokens and such. The main page of the clock editor consists of the following gadgets @{b}*@{ub} @{b}Display clock@{ub} This is the "main" gadget. If set, the clock will be displayed according to user settings. @{b}*@{ub} @{b}Display time@{ub} Tells @{b}MagicCX@{ub} to render the current system time @{b}*@{ub} @{b}Display secs@{ub} If you want to have the seconds displayed with the current system time, check this gadget @{b}*@{ub} @{b}Display date@{ub} To have the system date rendered to the time/memory display, check this gadget @{b}*@{ub} @{b}Set ENV vars@{ub} This might be of use for applications able to read ENV variables or for Shell users. @{b}MagicCX@{ub} may write the current Time, Date and Day informations to environment variables. If this gadget is set, variables with the names of "TIME", "DAY", "DATE" will be generated, containing the according information @{b}*@{ub} @{b}12-Hour mode@{ub} To have @{b}MagicCX@{ub} display the current time in 12-Hour mode rather than 24-Hour mode, check this gadget in order to have "am/pm" appended to the system time @{b}*@{ub} @{b}Display in window@{ub} If you don`t want to have the information rendered into the screen`s titlebar, but into a window, check this gadget and a window will pop up @{b}*@{ub} @{b}Display day@{ub} If you want to have the day name displayed, check this gadget @{b}*@{ub} @{b}Short dayname@{ub} If you prefer to have short (3 characters long) day names rather than the long daynames the system might produce, check this gadget @{b}*@{ub} @{b}Show mouse coords@{ub} This might be usefull for positioning items on Workbench or any other screen. If set, @{b}MagicCX@{ub} will report mouse coordinates relative to the active screen @{b}*@{ub} @{b}Follow to screen@{ub} This causes @{b}MagicCX@{ub} to let the clock pop up on the frontmost/active screen, ie. if you flip through screens, the clock will follow. @{b}*@{ub} @{b}Edit default and pages@{ub} This gadget will bring you to another window, where you can specify more settings for the clock. See @{"Clock pages" Link "Clock Editor"}. @EndNode @Node "Clock Editor" "MagicCX.guide/Clock Editor" @Prev "Clock" @Toc "Clock" Clock pages ----------- From within this window you may configure some more of the clock, including a user definable page (which is available starting with OS 2.1 and locale.library). @{b}*@{ub} @{b}Date format@{ub} You may choose from 6 different date formats, which are MM-DD-YY, DD-MM-YY, MM.DD.YY, DD.MM.YY, DD-MMM-YY, DD.MMM.YY @{b}*@{ub} @{b}Gauge width@{ub} For pages including the memory gauge you may set the size of the gauge relative to the clock screen`s width, ie. you specify a certain percentage the gauge should require to be rendered. @{b}*@{ub} @{b}User format@{ub} This string will only be available when running OS 2.1 with an installed locale.library. Using this String gadget, you may create your very own page with all the information you want to have (except for the gauge). The string is set up using tokens which identify several entries available for the page. Programmers might already know some of them as they are original locale.library tokens. Furthermore there are several others, unique to @{b}MagicCX@{ub}. The tokens supported by locale.library %a - abbreviated weekday name %A - weekday name %b - abbreviated month name %B - month name %c - same as "%a %b %d %H:%M:%S %Y" %C - same as "%a %b %e %T %Z %Y" %d - day number with leading 0s %D - same as "%m/%d/%y" %e - day number with leading spaces %h - abbreviated month name %H - hour using 24-hour style with leading 0s %I - hour using 12-hour style with leading 0s %j - julian date %m - month number with leading 0s %M - the number of minutes with leading 0s %n - insert a linefeed %p - AM or PM strings %q - hour using 24-hour style %Q - hour using 12-hour style %r - same as "%I:%M:%S %p" %R - same as "%H:%M" %S - number of seconds with leadings 0s %t - insert a tab character %T - same as "%H:%M:%S" %U - week number, taking Sunday as first day of week %w - weekday number %W - week number, taking Monday as first day of week %x - same as "%m/%d/%y" %X - same as "%H:%M:%S" %y - year using two digits with leading 0s %Y - year using four digits with leading 0s Furthermore there are those tokens introduced by @{b}MagicCX@{ub} and only supported by @{b}MagicCX@{ub} &c - Display free CHIP memory in Bytes &C - Display free CHIP memory in KBytes &f - Display free FAST memory in Bytes &F - Display free FAST memory in KBytes &m - Display free CHIP+FAST memory in Bytes &M - Display free CHIP+FAST memory in KBytes &o - Display current connect information Any characters/combinations not matching one of the above tokens will be displayed as entered. @{b}*@{ub} @{b}Exclusion Page@{ub} If you don`t want to have all pages available or if you don`t want to cycle through all available pages while looking for a specific page, you may exclude pages from being taken into consideration. Using this gadget you can select the page to exclude @{b}*@{ub} @{b}Exlude@{ub} If set will exclude the selected page from being displayed @EndNode @Node "Cycle to menu" "MagicCX.guide/Cycle to menu" @Next "Exploding Windows" @Prev "Clock" @Toc "The Modules" Turn Cycle gadgets into popup menus =================================== You definitely know Cycle gadgets. Isn`t it a pain to click through more than 4 entries? Using this module you have the opportunity to have cycle gadgets, which pop up menus you may select entries from. Those menus can be configured to your needs and tastes. If you click in the text box of a Cycle gadget it will pop up a menu. If you click on the Cycle gadget`s imagery to the left of the gadget, it will act as if it was a normal Cycle gadget. @{b}*@{ub} @{b}Sticky menus@{ub} If set, the PopUp menu will stay until a selection or cancel action has been placed, ie. you do not have to keep the left button pressed in order to make the menu stay @{b}*@{ub} @{b}Popup level@{ub} This level determines the minimum amount of entries a Cycle gadget should have in order to make it pop up a menu, ie. if you specify 3 for the "Popup level" and the Cycle gadget only offers 2 choices, it will not pop up a menu, but rather act like a normal gadget @{b}*@{ub} @{b}Zoom time@{ub} Popup menus may slowly grow to their size or simply pop up. If you specify a "Zoom time" greater than zero, the menu will slowly zoom/unzoom. @{b}*@{ub} @{b}Zoom mode@{ub} If a zoom time is specified you may tell @{b}MagicCX@{ub} which actions should be zoomed. - @{b}Create + Remove@{ub} Zoom when opening the menu; unzoom when closing it - @{b}Create@{ub} Only zoom when opening the menu - @{b}Remove@{ub} Only unzoom when closing the menu @{b}*@{ub} @{b}Popup type@{ub} Using this gadget you may set the menu`s position. Selection "Below container" will always open the menu below the gadget`s container box. "Over active" will open the menu over the gadget`s container, with the active entry centered over the container box. In either case, the menu will be repositioned if it can`t be displayed in full height/size. @{b}*@{ub} @{b}Draw seperator@{ub} In "Over active" mode, the menu would normally cover the seperator bar between the gadget`s imagery and the text box. If this gadget is set, the seperator bar will be drawn @{b}*@{ub} @{b}Menu type@{ub} You may select the menu`s look - @{b}Menu-like@{ub} Old style (OS 2.x like) menus, with a black background and a complement active entry. - @{b}Menu-like (NewLook)@{ub} New style (OS 3.x like) menus, with a white background and a black complement active entry. - @{b}Gadget-like@{ub} A Gadget-like display with various settings. @{b}*@{ub} @{b}Frame type@{ub} This is for "Gadget-like" menus only. Set the frame of the Popup menu`s border. You may either have "Normal", "Recessed", or "Double" borders. @{b}*@{ub} @{b}Hilite Box@{ub} This is for "Gadget-like" menus only. Set the hilitening box for active entries in the Popup menu. "None", only draw a bar. "Raised", draw blue bar surrounded by a raised box. "Recessed", same as "Raised" except for the box, that will be drawn recessed @EndNode @Node "Exploding Windows" "MagicCX.guide/Exploding Windows" @Next "Formatter" @Prev "Cycle to menu" @Toc "The Modules" Explode/Implode windows ======================= This is a special feature for opening/closing/sizing/moving windows. As soon as a window is opened/closed/sized/moved, frames will be drawn from a specified location to the window`s new location, in order to visualize the motion of the window. There are various settings for Exploding Windows, each motion can be disabled/enabled seperately. You may set the number of frames to draw for each motion, so that you may find a suitable combination of all four, usefull for your system. @{b}*@{ub} @{b}Exploding Windows@{ub} Tells @{b}MagicCX@{ub} to use Exploding Windows @{b}*@{ub} @{b}Explode/Implode@{ub} For Moving/Sizing it`s sure where to get source and destination positions from, ie. @{b}MagicCX@{ub} knows where to draw the frames from/to. For Exploding/Imploding you have the opportunity to specify locations where to go from/to. - @{b}Center@{ub} Will Explode/Implode from/to Center of the window`s screen - @{b}Mouse@{ub} Will Explode/Implode from/to the current mouse position, relative to the window`s screen - @{b}Center->Mouse@{ub} Will Explode from the center of the window`s screen and Implode to the current mouse position, relative to the window`s screen - @{b}Mouse->Center@{ub} Will Explode from the current mouse position relative to the window`s screen and implode to the center of the window`s screen @{b}*@{ub} @{b}Explode@{ub} Turn on exploding feature @{b}*@{ub} @{b}Explode frames@{ub} Specify the frames to draw for the explode motion @{b}*@{ub} @{b}Implode@{ub} Turn on imploding feature @{b}*@{ub} @{b}Implode frames@{ub} Specify the frames to draw for the implode motion @{b}*@{ub} @{b}Sizing@{ub} Turn on sizing feature @{b}*@{ub} @{b}Sizing frames@{ub} Specify the frames to draw for the sizing motion @{b}*@{ub} @{b}Moving@{ub} Turn on moving feature @{b}*@{ub} @{b}Moving frames@{ub} Specify the frames to draw for the moving motion @EndNode @Node "Formatter" "MagicCX.guide/Formatter" @Next "Function keys" @Prev "Exploding Windows" @Toc "The Modules" Disk watcher with auto formatting capability ============================================ Well, you certainly know a formatter, but all the standard formatting programs can`t guess, whether to format an unformatted disk or not. Using this module, @{b}MagicCX@{ub} will monitor all inserted disks as to format them or not. As soon as there will be an unformatted disk in one of the monitored drives, @{b}MagicCX@{ub} will pop up a requester asking whether to format the disk or not. If you have plenty of unformatted disks to be formatted, @{b}MagicCX@{ub} offers an "auto-labeling" mechanism for easily uniquely labeling the disks formatted. The formatter window (see @{"Formatter Window" Link "Formatter Window"}), can also be opened when not invoked through @{b}MagicCX@{ub} as of an unformatted disk, you may even open it up yourself to format a disk. See @{"Formatter window" Link "Formatter Window"}, for more information on the Formatter Window. @{b}*@{ub} @{b}Formatter active@{ub} Tells @{b}MagicCX@{ub} to monitor those drives, specified with DF0:-DF3:, ie. if this gadget isn`t set, @{b}MagicCX@{ub} will ignore unformatted disks inserted in any of your disk drives @{b}*@{ub} @{b}DF0:-DF3:@{ub} Check those gadgets if you want to monitor the corresponding disk drive. @{b}*@{ub} @{b}Auto label@{ub} If this gadget is set, @{b}MagicCX@{ub} will automatically increment an internal counter after every format. This way you can create successive formats with unique labels for all the disks inserted. The label for the disks will be somewhat of the form "Empty_%ld", where "%ld" is the number of the disk. @{b}*@{ub} @{b}Highest label@{ub} Will set the highest possible label number for auto labeling. If the format counter exceeds this number, it will restart with "1" @{b}*@{ub} @{b}Formatter@{ub} @{b}MagicCX@{ub} doesn`t have a Formatter routine built in, it rather utilizes an external Formatter like that of your Workbench. It even supports Olaf 'Olsen' Barthel`s Formatter (1). Simply enter the complete path and name of the formatter to use ---------- Footnotes ---------- (1) The latest version of this formatter can be found on Fish Disk @EndNode @Node "Formatter Window" "MagicCX.guide/Formatter Window" @Prev "Formatter" @Toc "Formatter" The Formatter`s window ---------------------- This window contains all the gadgets needed to configure the formatter for the next formatting job. It consists of many Checkmark gadgets, some of which are only applicable to the Formatter by Olaf 'Olsen' Barthel. These gadgets are marked as such. @{b}*@{ub} @{b}Drive@{ub} Let`s you select a drive to format. You can choose from the drives connected @{b}*@{ub} @{b}Name@{ub} Set`s the label of disk to be formatted. If "Auto label" is turned on for the Formatter, a new label will be placed here all the time the Formatter is invoked. @{b}*@{ub} @{b}Trashcan@{ub} Create a Trashcan on the disk @{b}*@{ub} @{b}Quick@{ub} Do a quick format. Only of use for already formatted disks @{b}*@{ub} @{b}FFS@{ub} Create a FastFileSystem on the new Disk. This filing system can only be used under OS 2.x and up @{b}*@{ub} @{b}Directory Cache@{ub} Only for OS 3.x and up and in conjunction with the original Workbench Formatter. Formats the disk with Directory Caching turned on. @{b}*@{ub} @{b}International@{ub} Only for OS 3.x and up and in conjunction with the original Workbench Formatter. Formats the disk in International mode @{b}*@{ub} @{b}No Verify@{ub} Only of use in conjunction with Olaf Barthel`s Formatter. Tells the formatter not to verify the format @{b}*@{ub} @{b}Install@{ub} Only of use in conjunction with Olaf Barthel`s Formatter. Will cause the formatter to install the disk after a format, ie. you may boot from this disk. @{b}*@{ub} @{b}Eject@{ub} Only of use in conjunction with Olaf Barthel`s Formatter. Some drives accept an Eject command which causes them to eject a disk. If used, the Formatter will force the drive to eject a disk after a format @EndNode @Node "Function keys" "MagicCX.guide/Function keys" @Next "Grabber" @Prev "Formatter" @Toc "The Modules" Define your own Function keys ============================= Using @{b}MagicCX@{ub} you may bind strings/commands to your function keys. These strings can be bound to the Function Key itself or can be used in conjunction with one of four qualifiers, ie. you can have up to 5 different settings for a single function key, thus leading to 50 different settings for all the function keys. The strings of function keys will be directly fed into the normal input stream. They will be treated as if the strings were entered using the keyboard. @{b}*@{ub} @{b}FKeys active@{ub} Tells @{b}MagicCX@{ub} to check all hits to a function key and act respectively. @{b}*@{ub} @{b}Qualifier@{ub} Sets the qualifier to be hit in conjuction with a function key in order to get the string bound to it. The settings entries F1-F10 below will change context accordingly @{b}*@{ub} @{b}Shown@{ub} On the Function Keys page there will be only 5 Function Keys shown. Using this gadget you may toggle between pages @{b}*@{ub} @{b}F1-F5, F6-F10@{ub} Those gadgets are used to set the strings/commands for a function key and it`s qualifier. Simply enter the string/command to your willing. If the "Mode" field for a gadget is set to "String", you may enter pure strings with the following special characters: - @{b}ANSI@{ub} - Any ANSI sequences may be entered. - @{b}Special codes starting with \ @{ub} 1. @{b}\n@{ub} - Return 2. @{b}\r@{ub} - Return 3. @{b}\t@{ub} - TAB 4. @{b}\\ @{ub} - \-Code - @{b}Keydefinition between <>@{ub} An example: abc\nHello. This would insert the definition of ALT + F1 between abc and \n. As you can see these definitions are the same as presented in @{"Defining a HotKey" Link "Manual HotKey Definition"}. If "Mode" is set to "CMD" you may use one of three internal commands, which are: - @{b}MINWIN@{ub} The window underneath the mouse pointer will be changed to minimum size and moved to the upper left corner of the screen. - @{b}MAXWIN@{ub} The window underneath the mouse pointer will be brought to maximum size and moved to the upper left corner of the screen. - @{b}ZIPWIN@{ub} Windows equiped with a Zoom Gadget can be handeled using this command. The window underneath the mouse pointer will zip to it`s alternative size/position. @{b}*@{ub} @{b}Mode a-e@{ub} Those gadgets are used to set the mode for a function key. Refer to the description of the String gadgets above, in order to find out what they are good for. @EndNode @Node "Grabber" "MagicCX.guide/Grabber" @Next "HotKey definitions" @Prev "Function keys" @Toc "The Modules" Grab/Print active screen/window =============================== Using @{b}MagicCX@{ub} you may grab an active screen/window and either save it to an IFF-ILBM file or print it to a graphics capable printer. Grabbing is accomplished through one of @{b}MagicCX`s@{ub} internal HotKeys. The grabber offers plenty of possibilities on how to handle a grab. Those ILBM files saved by the grabber can be loaded and manipulated by any ILBM aware graphics software. @{b}*@{ub} @{b}Save to clipboard@{ub} If you save an active screen/window, it will be stored in Clipboard unit 0, so you may directly reinsert it into a Clipboard supporting application @{b}*@{ub} @{b}Default directory@{ub} If "Save to clipboard" is turned off, you may set a default directory for ILBM files created by the grabber. All files will be stored to this directory and automatically labeld like this "Image_%ld", where "%ld" is the number of the image. @{b}Warning:@{ub} When restarting @{b}MagicCX@{ub}, the internal counter will be set to "0", thus old images will be overwritten, if they match the name of a new grab. @{b}*@{ub} @{b}Ask for filename@{ub} If you don`t like the automatic save feature, check this gadget in order to have @{b}MagicCX@{ub} open up a FileRequester. This way you can tell @{b}MagicCX@{ub} where to store the Image and how to name it. @{b}*@{ub} @{b}Notification@{ub} @{b}MagicCX@{ub} offers the possibility to notify you after a successfull grab. This can either be "None", "DisplayBeep()", or "8SVX-Sound". "None" will not notify you, "DisplayBeep()" will use the system`s beep facility and "8SVX-Sound" will play the sample, specified below. @{b}*@{ub} @{b}Soundname@{ub} If using "8SVX-Sound" notification, you may enter the path/name of a sample to play. @{b}*@{ub} @{b}Volume@{ub} Set the volume for the sample to play @{b}*@{ub} @{b}Test sample@{ub} Test the sample with the given volume @EndNode @Node "HotKey definitions" "MagicCX.guide/HotKey definitions" @Next "Hunt windows" @Prev "Grabber" @Toc "The Modules" HotKey definitions ================== From within this window you may alter @{b}MagicCX`s@{ub} commodities-like HotKeys. HotKeys may be turned on and off as to your willing. Redefine the HotKey definition for a HotKey as you like. Simply select a HotKey from the "HotKeys" list and act on it. The "HotKey active" gadget tells @{b}MagicCX@{ub} whether to use the HotKey or not. The "Description field" shows a small explanation of what the HotKey is supposed to do. Below you will find the definition for that particular HotKey. To alter the definition of a HotKey simply double click on the HotKey in the list, or click on the Picker gadget to the left of the HotKey Definition. A new window will pop up giving you the opportunity to simply set the HotKey by pressing the appropriate keys. If you somehow fail to specify the HotKey you want, click on the "Manually..." gadget and enter the HotKey Definition yourself. Refer to @{"Defining a HotKey" Link "Manual HotKey Definition"}, to find out more about the supported qualifiers and flags. Here is a list of HotKeys supported by @{b}MagicCX@{ub} @{b}*@{ub} @{b}Page@{ub} This is the HotKey to flip through the clock`s display pages @{b}*@{ub} @{b}Blank@{ub} Immediately blank the screen without waiting for the screen timeout. @{b}*@{ub} @{b}UserShell@{ub} Will call the defined command for creating a new shell (see @{"Miscellaneous 2" Link "Miscellaneous 2"}). @{b}*@{ub} @{b}Memory Snapshot@{ub} This is a special feature of @{b}MagicCX@{ub} not mentioned anywhere else. It serves as a memory watcher between two subsequent calls. If you first hit the HotKey DisplayBeep() will report that @{b}MagicCX@{ub} remembered the amount of free memory. A second hit on the HotKey will flip to a new page of the titlebar clock. It will now display the amount of memory consumed/freed between the two calls. Positive values show memory freed, negative values show memory used up. The display is split up into two parts "C:" for Chip memory and "F:" for Fast memory. To return to the normal display page, simply hit the Page HotKey or restart a new memory snapshot @{b}*@{ub} @{b}Center Screen@{ub} Horizontally center the active screen @{b}*@{ub} @{b}HuntWindows@{ub} Hunt for active window and move screen to show the new active window @{b}*@{ub} @{b}Formatter@{ub} Open the Formatter window (see @{"Formatter Window" Link "Formatter Window"}). @{b}*@{ub} @{b}Upper PubScreen@{ub} Turn the frontmost screen into the default Public Screen, as long as it is a Public Screen in public state. All windows not requesting a particular screen will now open on that screen. @{b}*@{ub} @{b}Open/Close all@{ub} This might be useful if you are using some or even all of the module`s windows. This HotKey will toggle the state of some of the windows supported by MagicCX. If you hit the HotKey the first time, the following windows will be closed. If you hit the HotKey again, all windows opened the time you hit the HotKey the first time, will be reopened. - @{b}Bill Window@{ub} - @{b}Clock Window/Titlebar@{ub} - @{b}Analog Clock@{ub} - @{b}Calendar@{ub} @{b}*@{ub} @{b}Clock on/off@{ub} Turn titlebar clock on/off @{b}*@{ub} @{b}Analog clock on/off@{ub} Turn analog clock on/off @{b}*@{ub} @{b}Calendar on/off@{ub} Turn calendar on/off @{b}*@{ub} @{b}FKeys on/off@{ub} Turn function key definitions on/off, ie. no more mapping of function keys will be performed if turned off. @{b}*@{ub} @{b}SunMouse on/off@{ub} Turn SunMouse feature on/off (see @{"Window related" Link "Window related"}). @{b}*@{ub} @{b}Map Umlauts on/off@{ub} Turn mapping of Umlauts on/off (see @{"Miscellaneous 1" Link "Miscellaneous 1"}). @{b}*@{ub} @{b}Display mouse on/off@{ub} Turn mouse coordinates on/off (see @{"Clock" Link "Clock"}). @{b}*@{ub} @{b}Screen Select@{ub} Open Screen Select window (see @{"Select Screen Select Screen" Link "Select Screen"}). @{b}*@{ub} @{b}Bill@{ub} Open Bill window (see @{"Telephone Bill" Link "Telephone Bill"}). @{b}*@{ub} @{b}Cycle connect@{ub} Cycle to next available connect in bill window (see @{"Telephone Bill" Link "Telephone Bill"}). @{b}*@{ub} @{b}Build connect@{ub} Build a manual connect (see @{"Telephone Bill" Link "Telephone Bill"}). @{b}*@{ub} @{b}Save screen@{ub} Save active screen to an IFF-ILBM file @{b}*@{ub} @{b}Save window@{ub} Save active window to an IFF-ILBM file @{b}*@{ub} @{b}Print screen@{ub} Print active screen to a printer @{b}*@{ub} @{b}Print window@{ub} Print active screen to a printer @EndNode @Node "Manual HotKey Definition" "MagicCX.guide/Manual HotKey Definition" @Prev "HotKey definitions" @Toc "HotKey definitions" Defining a HotKey ----------------- To ease the definition of a HotKey here is a list of key-descriptions the system "knows". Here is a list of qualifiers. @{b}@{b}ALT@{ub}@{ub} Any Alt key. @{b}@{b}RALT@{ub}@{ub} Only the right Alt key. @{b}@{b}LALT@{ub}@{ub} Only the left Alt key. @{b}@{b}SHIFT@{ub}@{ub} Either Shift key. @{b}@{b}RSHIFT@{ub}@{ub} The right Shift key. @{b}@{b}LSHIFT@{ub}@{ub} Only the left Shift Key. @{b}@{b}CAPSLOCK@{ub}@{ub} Capslock must be pressed. @{b}@{b}LCOMMAND@{ub}@{ub} Left Amiga key. @{b}@{b}RCOMMAND@{ub}@{ub} Right Amiga key. @{b}@{b}CONTROL@{ub}@{ub} Control Key. @{b}@{b}NUMERICPAD@{ub}@{ub} Keys of the Numeric Keypad are accepted. @{b}@{b}RBUTTON@{ub}@{ub} Right mousebutton. @{b}@{b}MIDBUTTON@{ub}@{ub} Middle mousebutton. @{b}@{b}LEFTBUTTON@{ub}@{ub} Left mousebutton. @{b}@{b}NEWPREFS@{ub}@{ub} Preferences have been changed. Maybe a new font was selected. @{b}@{b}DISKREMOVED@{ub}@{ub} A disk was removed from a drive. @{b}@{b}DISKINSERTED@{ub}@{ub} A disk was inserted into a drive. These are the qualifiers you can use in almost every combination. Now we come to the descriptions of "normal" keys. @{b}@{b}A - Z, 0 - 9, etc.pp.@{ub}@{ub} Normal keys, as you see them on the keyboard. @{b}@{b}F1 - F10@{ub}@{ub} The ten function keys. @{b}@{b}UP, DOWN, LEFT, RIGHT@{ub}@{ub} The cursor keys up, down, left, and right. @{b}@{b}HELP@{ub}@{ub} The Help key. @{b}@{b}DEL@{ub}@{ub} Delete key (beside HELP). @{b}@{b}BACKSPACE@{ub}@{ub} Backspace key @{b}@{b}RETURN@{ub}@{ub} Return key. @{b}@{b}ENTER@{ub}@{ub} Enter on Numeric Keyboard (only, if @{b}NUMERICPAD@{ub} was specified). @{b}@{b}ESC@{ub}@{ub} Escape key. @{b}@{b}SPACE@{ub}@{ub} Space. @{b}@{b}COMMA@{ub}@{ub} A comma. @{b}@{b}UPSTROKE@{ub}@{ub} The apostroph (to the left of the 1). You can use as many qualifiers as you wish, but only one key per description. This is the syntax for a HotKey definition: @{b}[QUALIFIER [QUALIFIER ...]] KEY@{ub} As you can see the qualifiers can be totally left out, but in how far this is usefull depends on you. @EndNode @Node "Hunt windows" "MagicCX.guide/Hunt windows" @Next "Key Cycling" @Prev "HotKey definitions" @Toc "The Modules" Hunt windows feature ==================== You probably know oversized autoscroll screens. If a window opens up in the invisible part of an oversized screen, you normally have to move around the screen in order to find the window. Using Hunt Windows, this is something of the past. It will move the screen to show the currently active window on it`s screen. @{b}*@{ub} @{b}Hunt windows@{ub} Turn on/off Hunt Windows feature @{b}*@{ub} @{b}Bring to front@{ub} Tell @{b}MagicCX@{ub} to automatically bring to front the active window @{b}*@{ub} @{b}Adjust X/Adjust Y@{ub} How to adjust the screen in order to show the window, split up in X and Y directions. If either of those is turned off, the screen will only be moved in the direction of the active adjustment. @{b}*@{ub} @{b}X Adjustment/Y Adjustment@{ub} How to adjust the screen. "Left", bring screen to a position, the window`s left border touches the monitor`s left border, "Right" opposite direction, "Center" tries to center the window. "Top", "Bottom" respectively for the Y adjustment. If the Screen can not be moved as far as needed, the window might not end up at the positions requested. @EndNode @Node "Key Cycling" "MagicCX.guide/Key Cycling" @Next "Lock windows" @Prev "Hunt windows" @Toc "The Modules" Key window/screen cycling ========================= Using this feature you may cycle through screens/windows using your keyboard with predefined key combinations. Refer to @{"HotKey definitions" Link "HotKey definitions"}, to find out how to alter the definition of a HotKey @{b}*@{ub} @{b}Screen to front/Screen to front key@{ub} Activate screen to front hotkey. If the "Screen to front key" is hit, the backmost screen will be brought to front @{b}*@{ub} @{b}Screen to back/Screen to back key@{ub} Activate screen to back hotkey. If the "Screen to back key" is hit, the frontmost screen will be brought to back @{b}*@{ub} @{b}Window to front/Window to front key@{ub} Activate window to front hotkey. If the "Window to front key" is hit, the backmost window on the active screen will be brought to front @{b}*@{ub} @{b}Window to back/Window to back key@{ub} Activate window to back hotkey. If the "Window to back key" is hit, the frontmost window on the active screen will be brought to back @EndNode @Node "Lock windows" "MagicCX.guide/Lock windows" @Next "Miscellaneous 1" @Prev "Key Cycling" @Toc "The Modules" Exclude windows from MagicCX`s window activation ================================================ This module is an extension to @{b}MagicCX`s@{ub} window activation factility (see @{"Window related" Link "Window related"}). Normally all windows will be activated according to mouse positions. This might be confusing or annoying sometimes. Say you have a Shell open and want to type in something, but the Mouse pointer isn`t located over the Shell window. So you start to type, but all characters entered end up somewhere else. Wouldn`t it be nice to have @{b}MagicCX@{ub} exclude several windows from being deactivated through its window activation feature? Simply specify Names/Patterns of window titles/window owner task names of windows not to be automatically deactivated. This is accomplished through a list of entries representing the windows to be locked. All entries are case insensitive and all AmigaDOS wildcards are supported. @{b}*@{ub} @{b}Entry type@{ub} Determines the type of entries found in the Listview. If "Windows" is selected all entries will be treated as window titles, ie. the window title of a window not to be deactivated should match one of the patterns specified here. if "Tasks" is specified the entries are treated as the names of programs owning the window(s) to be locked. @{b}*@{ub} @{b}Entries@{ub} The list of entries for the specified type @{b}*@{ub} @{b}Entry name@{ub} The name/pattern for the current entry. Select the Picker gadget to the right to open a window with all available windows/tasks, listed/sorted by name. You may then select an entry from the list for the active Lock Windows entry. @{b}*@{ub} @{b}New@{ub} Will create a new entry for the current list @{b}*@{ub} @{b}Remove@{ub} Will remove the active entry from the current list @EndNode @Node "Miscellaneous 1" "MagicCX.guide/Miscellaneous 1" @Next "Miscellaneous 2" @Prev "Lock windows" @Toc "The Modules" Miscellaneous page 1 ==================== Within this page there are several gadgets for smaller functions supported by @{b}MagicCX@{ub}. @{b}*@{ub} @{b}MMB Shift@{ub} If turned on, the middle mouse button of three button mice will act just like any SHIFT key, ie. you may use the middle mouse button for multi selections on Workbench or any other application supporting SHIFT selection of items @{b}*@{ub} @{b}No drive click@{ub} Turns off drive clicking of floppy drives @{b}*@{ub} @{b}No DisplayBeep()@{ub} Will disable the usage of Intuition`s function DisplayBeep(), thus no application will beep anymore @{b}including@{ub} @{b}MagicCX@{ub}. @{b}*@{ub} @{b}Wild Star@{ub} Will turn on the '*' as Wildcard/Joker for Shells. @{b}*@{ub} @{b}Upper PubScreen@{ub} Will automatically set the frontmost Public Screen to the default Public Screen, as long as this screen is in public state. All windows not requesting a specific screen will open on that screen now. @{b}*@{ub} @{b}Map Umlauts@{ub} This might be of use for German users or people writing german texts. Map Umlauts will convert any of the German Umlauts "ae", "oe", "ue", "ss" into the normal character pendants. This might be of use if writing news in a german (non Umlauts supporting) newsgroup. @{b}*@{ub} @{b}Menu wrap@{ub} Will alter the behaviour of the mouse when opening a menu. If you press your right mouse button with "Menu wrap" turned on, the mouse will jump to the menu bar, so that you may immediately start selecting items from the menu. Furthermore the mouse will be held within the menu`s bounds, ie. if you try to move the mouse past the left/right edges of the menu, it will reappear on the opposite side. If you let go your right mouse button, the mouse will jump back to the position it resided on before you hit the right mouse button @{b}*@{ub} @{b}String to menu@{ub} This feature will enable Menu selection from within String gadgets. If you are typing in some text in a String gadget and want to reach a menu item by using it`s shortcut, simply hit your right AMIGA key and the shortcut to select the menu. Except for the standard editing keys RIGHT-AMIGA 'q', RIGHT-AMIGA 'x', all other keys are supported. @{b}*@{ub} @{b}System wild star@{ub} Is an extension to "Wild Star". This one allows the usage of '*' as a joker throughout the system. @{b}*@{ub} @{b}Double X@{ub} This is for AGA users only. It will enable mode promotion of NTSC/PAL screens to DBLNTSC/DBLPAL. @EndNode @Node "Miscellaneous 2" "MagicCX.guide/Miscellaneous 2" @Next "Mouse Cycling" @Prev "Miscellaneous 1" @Toc "The Modules" Miscellaneous page 2 ==================== On this page you will find some more miscellaneous features of @{b}MagicCX@{ub}, which somehow require more settings than just on/off. @{b}*@{ub} @{b}UserShell@{ub} Specify the command for opening a new shell. This shell will be opened using the "UserShell" HotKey (see @{"HotKey definitions" Link "HotKey definitions"}). @{b}*@{ub} @{b}KeyClick@{ub} Turn clicking of keys on off. You probably know a clicking sound from other keyboards. As soon as you hit a key a click is heard. This feature is simulated through @{b}MagicCX@{ub}. @{b}*@{ub} @{b}All keys@{ub} Let all keys click, not only printable characters @{b}*@{ub} @{b}Repeat@{ub} Let the keys click, even when in repeat state @{b}*@{ub} @{b}Click sound@{ub} You may either use the "Internal" sound produced by @{b}MagicCX@{ub} or utilize an external "8SVX-Sound" for producing the click @{b}*@{ub} @{b}Click sample@{ub} Specify the sample to use for the click. Please specify the complete path @{b}*@{ub} @{b}Click volume@{ub} The volume for the click @{b}*@{ub} @{b}Enter ASCII@{ub} This is a feature borrowed from PCs. Hit the predefined "ASCII key" and enter a character`s ASCII value using your numeric keypad. If you let go the "ASCII key" or finish the code with the third digit, the character will be inserted into the main input stream @{b}*@{ub} @{b}ASCII key@{ub} Specify the qualifier to hit in order to enter the ASCII value of a character using your numeric keypad. @EndNode @Node "Mouse Cycling" "MagicCX.guide/Mouse Cycling" @Next "Mouse related" @Prev "Miscellaneous 2" @Toc "The Modules" Mouse window/screen cycling =========================== Using @{b}MagicCX@{ub} you can cycle through screens and windows using your mouse. @{b}MagicCX@{ub} even supports the middle mouse button to cycle through screens. @{b}*@{ub} @{b}Cycle front/Front clicks/Front key@{ub} Enable window/screen cycling to front. Specify the number of clicks that have to be placed ("Front clicks") in order to trigger the action. If you hit the specified "Front key" and hit it "Front clicks" times, @{b}MagicCX@{ub} will determine how to act. If the mouse is placed over a window, which is non-backdrop and has a depth gadget attached, it will be brought to front. Otherwise the window`s screen will be brought to front. This will of course happen, too, if you click on the screen itself with no window underneith the mouse. @{b}*@{ub} @{b}Cycle screens/Screen clicks/Screen key@{ub} This is for screen cycling. Per default this is set to the middle button of a mouse. If you hit the "Screen key" "Screen clicks" times, the frontmost screen will be brought to back. @{b}*@{ub} @{b}Cycle back/Back clicks/Back key@{ub} Same as for "Cycle front" with the exception that windows/screens will be brought to back according to the rules mentioned under "Cycle front". @EndNode @Node "Mouse related" "MagicCX.guide/Mouse related" @Next "MoveSizer" @Prev "Mouse Cycling" @Toc "The Modules" Mouse related features ====================== On this page you will find some mouse related features. @{b}*@{ub} @{b}Lefty mouse@{ub} Will swap left and right button of your mouse, ie. if you hit the right button it will act like the left and vice versa @{b}*@{ub} @{b}Mouse Acceleration@{ub} Turns on/off mouse acceleration. The mouse will be accelerated according to "Acceleration" and "Threshhold" settings @{b}*@{ub} @{b}Acceleration@{ub} Specifies the amount of acceleration for the mouse. @{b}*@{ub} @{b}Threshhold@{ub} Specifies the amount of threshhold for mouse acceleration. The lower, the earlier the mouse will be accelerated. @{b}*@{ub} @{b}Hold mouse@{ub} Using this feature you may restrict mouse movements to certain directions, using the "Hold X" and "Hold Y" keys. @{b}*@{ub} @{b}Hold X@{ub} Specifies the key to hit in order to restrict the mouse to vertical movements @{b}*@{ub} @{b}Hold Y@{ub} Specifies the key to hit in order to restrict the mouse to horizontal movements @EndNode @Node "MoveSizer" "MagicCX.guide/MoveSizer" @Next "Select Screen" @Prev "Mouse related" @Toc "The Modules" Size/Move windows with any click ================================ Using this module you may drag around windows by a click to any place within the window or even size a window in any direction by clicking on the appropriate borders. If you click on a single border the window can be sized in that direction. If you click on a corner of the window, the window can be sized in both directions the corner points to. You may even size windows without sizing gadget, even though this is not that nice. @{b}*@{ub} @{b}Move window/Move key@{ub} Turns on/off the move window feature. If you hit the "Move key", you may drag around the current window by a click to any location within the window. This feature is restricted to non-backdrop windows which contain a drag bar, ie. it should be a window which can be dragged around normally, too. @{b}*@{ub} @{b}Size window/Size key@{ub} Turns on/off the size window feature. If you hit the "Size key" on the borders of a non-backdrop window, you may size the window in that direction the border faces, ie. if you grab the upper border you may size the window vertically while keeping the lower end of the window at it`s original position. If you grab a corner of the window, you may size the window in two directions simultaniously. If you grab the lower left corner you may size it horizontally and vertically while keeping the right and upper edges at their original positions. @{b}*@{ub} @{b}Border size/Corner size@{ub} Determines the senstive parts of a window. Border size will set the number of pixels from a border of a window, which will react on a single direction sizing operation. Corner size determines the size of the four corners of a window. Corners are checked for first @EndNode @Node "Select Screen" "MagicCX.guide/Select Screen" @Next "Special Cycling" @Prev "MoveSizer" @Toc "The Modules" Select a screen/window easily ============================= This module offsers possibilities to easily select a screen which should be brought to front. Alternatively you may even select windows from within the Screen Select window (see @{"Screen Select Window" Link "Screen Select Window"}), whose screens should be brought to front. The windows then, of course, will be brought to front, too, and will be activated then. You may even have a special menu to choose screens from. @{b}*@{ub} @{b}Select menu@{ub} If enabled, the depth gadget of screens will get a new meaning. If you click on a screen`s depth gadget with your right mouse button, @{b}MagicCX@{ub} will present a menu underneith the mouse, from which you may select a screen or a screen`s window. The menu is set up as follows: The main items within the menu contain the screen names known to the system. If a screen is public there will be a "" indicator in front of it`s public name. If it isn`t public there will be a "" indicator with the screen`s title (if any). The menu item`s subitems contain the screen identifier itself as first entry and all the windows for that screen as following entries. Simply select an entry from the subitem list and the Screen and window (if you have selected a window) will be brought to front and the window will be activated. @{b}*@{ub} @{b}Smart depth active/Smart depth key@{ub} If you click on the depth gadget with your left mouse button while holding down the "Smart depth key" and having selected "Smart depth active", @{b}MagicCX@{ub} will pop up the Screen Select Window (see @{"Screen Select Window" Link "Screen Select Window"}). @EndNode @Node "Screen Select Window" "MagicCX.guide/Screen Select Window" @Prev "Select Screen" @Toc "Select Screen" The Screen Select Window ------------------------ The Screen Select Window contains a list of available screens and their windows (if selected). Simply select an entry and act on it. You may grab/print an entry just like with the Grabber (see @{"Grabber" Link "Grabber"}), or simply activate/bring to front the entry. For Public Screens, you may even declare a screen entry as default Public Screen. @{b}*@{ub} @{b}Screens/Windows@{ub} Contains the list of screens/window. Screens will be prefixed with "" if they are public or by "" if they are normal custom screens. The screen`s windows, will be indented and prefixed by "- " to show which screen they reside on. @{b}*@{ub} @{b}Number of Screens/Default Pub screen@{ub} Shows information about the number of available screens and the name of the default Public Screen @{b}*@{ub} @{b}Grab@{ub} Will save the active entry according to the Grabber settings (see @{"Grabber" Link "Grabber"}). @{b}*@{ub} @{b}Show windows@{ub} Turns on/off window entry displaying @{b}*@{ub} @{b}Print@{ub} Will print the active entry according to the Grabber settings (see @{"Grabber" Link "Grabber"}). @{b}*@{ub} @{b}Activate@{ub} Will bring to front/activate the active entry @{b}*@{ub} @{b}Renew list@{ub} Will update the list @{b}*@{ub} @{b}Set as default@{ub} Only available for Public Screens: Will declare the active entry to the new default public screen @{b}*@{ub} @{b}Cancel@{ub} Will cancel the Screen Select Window @EndNode @Node "Special Cycling" "MagicCX.guide/Special Cycling" @Next "TagScreens" @Prev "Select Screen" @Toc "The Modules" Special window cycling ====================== This is a special form of window cycling, restricted to windows whose titles match one of the patterns specified. This way you may cycle through special windows you have to cope with a lot (eg. Shell windows). Simply enter a pattern for the title of the window(s) and go for it. If @{b}MagicCX@{ub} encounters a window matching a pattern, it will be brought to front/activated. All AmigaDOS wildcards are supported, names are treated case-insensitive @{b}*@{ub} @{b}Special cycling/Special key@{ub} Turns on/off special cycling. If you hit the "Special key", @{b}MagicCX@{ub} tries to find the next matching window on the active screen. It will then be brought to front/activated @{b}*@{ub} @{b}Window names@{ub} The list of names/patterns to look for @{b}*@{ub} @{b}Name@{ub} The entry name. You may use the Picker gadget to the right to select the name of a window from the list of known windows @{b}*@{ub} @{b}New/Clone/Remove@{ub} Will create a new entry, clone an entry, remove the active entry from the list @EndNode @Node "TagScreens" "MagicCX.guide/TagScreens" @Next "Telephone Bill" @Prev "Special Cycling" @Toc "The Modules" Force old type screens to new ones ================================== The TagScreens module is a sophisticated system for promoting screens to other screens or enhancing screens. It offers the possibility to have a global tag, which servers as a master configuration for all entries not included in the list of TagScreens entries. It can be configured the same way as all the other entries as well. Furthermore you may alter specific screens bei their names or force all screens generated by an application to new styles/types. This is accomplished by two seperate lists with entries which are set up by patterns. You may even protect screens from being manipulated through the global settings by marking them. All AmigaDOS wildcards are supported and all names are treated case insenstively. @{b}Warning:@{ub} TagScreens is somewhat highly sophisticated and should only be used by people who know what they are doing. Otherwise crashes are predefined. @{b}*@{ub} @{b}TagScreens active@{ub} Turns on/off the TagScreens module @{b}*@{ub} @{b}Use global/Global settings@{ub} Enables the global tag. Using "Global settings" you may configure the global tag using the Edit entry window (see @{"Edit TagScreens Entry" Link "Edit TagScreens Entry"}). @{b}*@{ub} @{b}Type@{ub} Specifies the type of list to be displayed in the ListView gadget. Entries can either be "Screennames", ie. the entries should be patterns matching the Screen titles, or "Tasknames", which means that you should use the names of an application. All screens created by this application will receive the settings made for the entry. @{b}*@{ub} @{b}Entries@{ub} The entry list itself. It will either contain the screens` names or the tasks` names. @{b}*@{ub} @{b}Entry name@{ub} The name of the active entry currently being edited. Using the Picker gadget to the right you may select a screen name or task name from a list of known screens/tasks. If you want to protect this entry from being manipulated by the global settings, simply precede it with a "-". @{b}*@{ub} @{b}New/Edit/Clone/Remove@{ub} Create a new entry, edit the active entry, clone the active entry, or remove the active entry from the currently displayed list. @EndNode @Node "Edit TagScreens Entry" "MagicCX.guide/Edit TagScreens Entry" @Prev "TagScreens" @Toc "TagScreens" Edit a TagScreens entry ----------------------- Entries of a TagScreens list will be edited here. You have plenty of options you may choose from. @{b}*@{ub} @{b}Hard Patch@{ub} This is for OS 2.x aware applications, which already use so-called TagLists to create their screens. Normally @{b}MagicCX@{ub} refuses to alter a screen created using TagLists (except for some, which are marked accordingly). If you set "Hard Patch", @{b}MagicCX@{ub} will also alter screens using Tags. @{b}*@{ub} @{b}AutoScroll@{ub} Will enable AutoScroll feature for screens being too large to fit on the monitor @{b}*@{ub} @{b}BlackBorder@{ub} Removes the white border from screens and replaces it by a black border. This can be used with or without "Hard Patch" turned on, no matter which way the screen is opened. @{b}*@{ub} @{b}AutoCenter@{ub} Will horizontally center the screen if it is too small to fill the whole montior. Can be used with any type of screen, no matter if "Hard Patch" is turned on. @{b}*@{ub} @{b}Interleaved@{ub} Will create Interleaved BitMaps for better performance. This feature is only available under OS 3.x and up. @{b}*@{ub} @{b}SAPens@{ub} Will set the Pen array to use for rendering gadgets and windows on the screen. This is of use for old OS 1.3 style screens @{b}*@{ub} @{b}LikeWB@{ub} Will create a screen just the same type like the Workbench screen. This feature is only available under OS 3.x and up. @{b}*@{ub} @{b}SA-System-Pens@{ub} Normally @{b}MagicCX@{ub} will use the OS 2.x like pens for setting the pen array. If you specify "SA-System-Pens", @{b}MagicCX@{ub} will try to find the correct pens according to the version of OS you are running. @{b}*@{ub} @{b}Set ScreenMode/ModeID@{ub} Will give you the opportunity to alter the screenmode of a screen. Simply select the new ScreenMode from the list of Modes using the ScreenModeRequester. If you are not running asl.library V38, reqtools.library V38 will be used. reqtool.library V38 is part of the @{b}MagicCX@{ub} distribution. @{b}*@{ub} @{b}Change size/Width/Height@{ub} Using these gadgets you may alter the dimensions of the screen. Simply set the width/height for the screen @{b}*@{ub} @{b}Change depth/Depth@{ub} You may even alter the depth (number of colors) of the screen. @{b}*@{ub} @{b}Make screen public/Public name@{ub} If the screen you want to alter isn`t a Public Screen, you may force the screen to being public using these gadgets. Simply enter the name for the Public Screen. @{b}*@{ub} @{b}Set Font/Font@{ub} Alter the font to use for the screen to open. Select a font from the FontRequester opened by clicking on the Picker gadget to the right of the gadget. @EndNode @Node "Telephone Bill" "MagicCX.guide/Telephone Bill" @Next "ToolAlias" @Prev "TagScreens" @Toc "The Modules" Calculate telephone costs ========================= The Telephone Bill module is the most complex of all. It allows you to automatically store informations about incoming and outgoing phone calls with ease. It monitors connects on selected serial devices and tries to determine the number you have called. From a list of areacodes it then even tries to determine the timezone to use so that all costs calculated are authentic. From a rates panel you may specify special days and dates when to use other settings as the default ones. You may even build a manual connect, say if you are placing a phone call and want to store informations about that call, too. The Telephone Bill module is able to control an unlimited number of connects (only restricted to the amount of free memory). You may cycle through the running connects from either the Bill window (see @{"Bill window" Link "Bill Window"}, or by using a HotKey (see @{"HotKey definitions" Link "HotKey definitions"}). @{b}*@{ub} @{b}Configure bill@{ub} This button will lead you to the configuration window, for the bill window. See @{"Configure Bill" Link "Edit Bill Window"}, for more information. @{b}*@{ub} @{b}Edit rates@{ub} Will open the most complex editor of @{b}MagicCX@{ub}. You may alter day/date rates for all supported timezones here. See @{"Edit rates" Link "Edit Rates"}, for more. @{b}*@{ub} @{b}Edit AreaCodes@{ub} Set up the AreaCodes @{b}MagicCX@{ub} should determine the timezones from. See @{"Edit AreaCodes" Link "Edit AreaCodes"}, for more information. @{b}*@{ub} @{b}Edit devices@{ub} The devices/units to monitor for connects. See @{"Edit devices" Link "Edit Devices"}, for more. @{b}*@{ub} @{b}Show log@{ub} Either dump the contents of the log file to a window showing all informations, or dump the same information to a file for later use. @{b}*@{ub} @{b}Delete log@{ub} Will delete the logfile and reset the "Full costs" indicator @{b}*@{ub} @{b}Logname@{ub} Specifies the name of the logfile, informations will be written to @{b}*@{ub} @{b}Full costs@{ub} All accumulated costs @EndNode @Node "Bill Window" "MagicCX.guide/Bill Window" @Next "Edit Bill Window" @Prev "Telephone Bill" @Toc "Telephone Bill" The Bill Window --------------- The Bill Window shows information for the current connect or for a connect you selected. It will display the following informations: In zoomed state, the window title will show a reduced set of informations concerning the active entry. It shows something like this: "X: C:CC:CC/R:RR:RR-VVV-T-S" | | | | | | | | | | | Save/Ignore connect (Don`t save) | | | | | | | | | Timezone | | | | | | | Costs | | | | | Remaining time for the current unit | | | Connect time for this connect | Connect number @{b}*@{ub} @{b}Connecttime@{ub} The connecttime for this connect and the remaining time for the unit @{b}*@{ub} @{b}Cost@{ub} Ths costs for the current connect and the full costs including previous and all other running connects @{b}*@{ub} @{b}Dialed@{ub} The dialed number. If @{b}MagicCX@{ub} wasn`t able to determine the number dialed or if the connect was set up manually it will show "--Manual Connect--" Using the following gadgets, you may configure the current connect or retrieve further information. @{b}*@{ub} @{b}Save to log@{ub} Save information about this connect to the logfile. @{b}*@{ub} @{b}Timezone@{ub} Specify a timezone for the connect with different unit/cost options @{b}*@{ub} @{b}Costs/hour@{ub} The costs per hour for the running connect according to the connect settings. The lower four gadgets aid in controlling connects. @{b}*@{ub} @{b}Previous@{ub} Will bring you to the previous connect in the list of connects @{b}*@{ub} @{b}Connect@{ub} Will launch a manual connect which can be interrupted using "Disconnect" @{b}*@{ub} @{b}Disconnect@{ub} Will interrupt the current @{b}manual@{ub} connect. Connects built by a modem can not be interrupted manually. @{b}*@{ub} @{b}Next@{ub} Will bring you to the next connect in the list of connects. @EndNode @Node "Edit Bill Window" "MagicCX.guide/Edit Bill Window" @Next "Edit Rates" @Prev "Bill Window" @Toc "Telephone Bill" Configure the Bill Window ------------------------- From within this window you may configure the Bill Window. @{b}*@{ub} @{b}Open bill window@{ub} Open the bill window if a connect was detected on one of the monitored devices/units @{b}*@{ub} @{b}Bill active on popup@{ub} Activate the bill window when opening @{b}*@{ub} @{b}Bill zoomed@{ub} When opening the Bill window zip to alternate position, ie. small window. @{b}*@{ub} @{b}Popup delay@{ub} If a connect has been detected on one of the devices/units and the Bill window isn`t open yet, wait x seconds before opening @{b}*@{ub} @{b}Connectime@{ub} Approximate time for your modem to set up a connect. This is useful for having the Telephone Bill module working with realistic values. @{b}*@{ub} @{b}Public Screens@{ub} Names of Public Screens the Bill Window should open on. Simply enter the Public Names of Public Screens seperated by semicolons, commas or spaces, or select a name from the list using the Picker gadget. @EndNode @Node "Edit Rates" "MagicCX.guide/Edit Rates" @Next "Edit AreaCodes" @Prev "Edit Bill Window" @Toc "Telephone Bill" Configure rates for timezones ----------------------------- This is the most complex window of all. You may configure special days/dates for each timezone. Each entry of the days/dates may have it`s own list of times where special units/costs apply. Each timezone has a special entry "Standard settings". This entry can not be deleted from the list as every timezone needs some information about how to handle units, duration of units, costs of units etc.pp. Exceptions may be added to the list of days/dates where other settings apply in contradiction to the ones set up for the "Standard settings". Defaults for this window are the three timezones of Germany, including Weekends with reduced costs. For each "Days/Dates" entry you have to specify time entries (or a single entry). These entries determine ranges for which the Unit fields apply. An example: Standard settings for a normal workday in Germany are (Timezone 1): 8:00 - A unit lasts 360 seconds and costs 23 Pfennige These settings last until 18:00 the same workday 18:00 - A unit lasts 720 seconds and costs 23 Pfennige These settings last until 8:00 the next workday So you simply set times for an entry to what you want. Enter the start time for a new range and set the Unit fields accordingly. Times entered/altered will be sorted by "smallest-first", so that ranges don`t overlap. At weekends, we have reduced costs for phone calls, so we add an exception to the list of "Days/Dates" which is a "Days" entry. We set the exception to Sunday and Saturday, and specify times for that entry. As there is only one time range for weekends, we set the first and only time to "0:00", so that this time range will be used with the beginning of a weekend 0:00 - A unit lasts 720 seconds and costs 23 Pfennige The "First Unit" fields correspond to the very first unit passed, while the "Following Units" corresponds to all units following the very first. @{b}*@{ub} @{b}Time zone@{ub} Select the timezone whose entries you want to alter. The "Days/Dates" gadget will now contain all the entries for the specified timezone. The first entry will be selected and the "Time" Gadget will contain the time(s) for that entry. The "First Unit"/"Following Units" will be set according to the settings of the first "Time" entry. @{b}*@{ub} @{b}Days and Dates@{ub} This ListView gadget contains the "Standard settings" and exceptions for the current timezone. Simply select an entry to alter it`s times or alter an exception. @{b}*@{ub} @{b}Time@{ub} This is the list of times for the selected "Days/Dates" entry. There must be at least one entry for that list. Select the time you want to edit and alter it`s start time and/or Unit fields. @{b}*@{ub} @{b}First Unit/Following Units@{ub} These fields are used to set the costs for an unit and it`s duration for the active time entry. You have to enter the smallest amount of your currency in the "Cents/Unit" fields, ie. Pfennige, Cents.... @{b}*@{ub} @{b}Add time@{ub} Add a new time to the list of times for the selected "Days/Dates" entry. The list will be sorted then. @{b}*@{ub} @{b}Remove time@{ub} Remove a time entry from the list of times of the selected "Days/Dates" entry. The last entry in the list can not be deleted @{b}*@{ub} @{b}Edit time@{ub} Edit a time entry. The list will be resorted then @{b}*@{ub} @{b}Add date@{ub} Add a date exception to the "Days/Dates" list of the current timezone. A window will open up giving you the opportunity to select the date. Please keep in mind that no date exceptions like the 31. of April will be handled. You should know what you are doing. Enter a comment like "Christmas" and hit "Ok". Now set the times for the new entry. @{b}*@{ub} @{b}Add day@{ub} Add a day(s) exception to the "Days/Dates" list of the current timezone. You may select any weekday from this window and enter a comment for the "Days/Dates" entry. Now set the times for the new entry. @{b}*@{ub} @{b}Edit entry@{ub} Will let you edit an exception entry from the "Days/Dates" list of the current timezone. The "Standard settings" entry can not be edited. @{b}*@{ub} @{b}Clone entry@{ub} Will clone the active "Days/Dates" entry. "Standard settings" can not be cloned @{b}*@{ub} @{b}Remove entry@{ub} Will remove the active "Days/Dates" entry. "Standard settings" can not be cloned @EndNode @Node "Edit AreaCodes" "MagicCX.guide/Edit AreaCodes" @Next "Edit Devices" @Prev "Edit Rates" @Toc "Telephone Bill" Configure AreaCodes for Telephone Bill -------------------------------------- Using this window you may enter AreaCodes, @{b}MagicCX@{ub} should use to determine specific timezones. If @{b}MagicCX@{ub} is successfull in filtering the telephone number you`ve called it tries to determine the timezone from this list of AreaCodes. Simply enter patterns or the first digits of an AreaCode and set the timezone for this AreaCode. For example: If you call someone who`s AreaCode starts with "061" and this would mean timezone 2 for you, enter "061" or "061#?" and set the timezone to 2. @{b}*@{ub} @{b}AreaCodes@{ub} List of area codes @{b}*@{ub} @{b}AreaCode@{ub} The current areacode you are editing. Enter the first digits or digits containing a pattern for the area code. @{b}*@{ub} @{b}TimeZone@{ub} The timezone for the current AreaCode. @{b}*@{ub} @{b}New/Clone/Remove@{ub} Create a new AreaCode, Clone the active AreaCode, Remove the active AreaCode @EndNode @Node "Edit Devices" "MagicCX.guide/Edit Devices" @Prev "Edit AreaCodes" @Toc "Telephone Bill" Configure devices for Telephone Bill ------------------------------------ Using this window you may set the devices/units to monitor and check for connects. If you want to monitor "serial.device" unit "0" (default port for modem connections), you would simply enter "serial.device" and set unit "0" for it. @{b}*@{ub} @{b}Devices@{ub} The list of devices monitored by @{b}MagicCX@{ub}. The list will not display the trailing ".device" part of a device name, even though you have to enter it. @{b}*@{ub} @{b}Device name@{ub} The name of the selected device. To select a device from a list, click on the Picker Gadget to the right of the gadget. @{b}*@{ub} @{b}Unit number@{ub} The unit number of the device to monitor. If you want to monitor multiple units of the same device, you have to create multiple instances of the device and set the unit number accordingly. @{b}*@{ub} @{b}New/Clone/Remove@{ub} Create new entry, Clone active entry, Remove active entry @EndNode @Node "ToolAlias" "MagicCX.guide/ToolAlias" @Next "Window related" @Prev "Telephone Bill" @Toc "The Modules" Substitute Default Projects =========================== This is a rather small feature of @{b}MagicCX@{ub}, but it might be helpfull for (eg) users of CDRoms or users who frequently take a look at FD disks/CDs. You probably know this: You get a new program and it`s documentation, you double click on the Doc`s icon and the system requests some text viewer, you don`t like/own. Wouldn`t it be nice if some default projects would be "mapped"/"redirected" to different tools? Simple, use ToolAlias. Enter path/programs and the substitute for that program. That`s it. @{b}*@{ub} @{b}ToolAlias active@{ub} Turns on/off ToolAlias @{b}*@{ub} @{b}Tools@{ub} The list of tools to be mapped including the destination programs. The left side of an entry is the old program, while the right is the new one. @{b}*@{ub} @{b}Old name@{ub} Enter the name/pattern of the old program. You don`t actually have to enter the path if you are using a pattern. @{b}*@{ub} @{b}New name@{ub} The new program to use in place of the old one. Simply enter the name/path of the program to use. You can use the Picker gadget to select a program from a FileRequester. @{b}*@{ub} @{b}New/Clone/Remove@{ub} Create a new pair, Clone the active pair, Remove the active pair from the list @EndNode @Node "Window related" "MagicCX.guide/Window related" @Next "ARexx" @Prev "ToolAlias" @Toc "The Modules" Window related features ======================= On this page you will find window related features of @{b}MagicCX@{ub}. @{b}*@{ub} @{b}Window activate@{ub} Turns on window activation using the specified "Sun mouse" mode. Please refer to @{"Lock windows" Link "Lock windows"}, for more information about window activation. @{b}*@{ub} @{b}Sun mouse@{ub} Specifies the mode of window activation. If "Sun mouse" is set, every window touched by the mouse will be activated. If turned off, every window underneith the mouse will be activated, as soon as you hit a key. @{b}*@{ub} @{b}Sun mouse delay@{ub} This is for "Sun mouse" window activation. If delay is set to "0", every window touched by the mouse will be activated, regardless of mouse speed. If you set delay to somewhat different than "0", @{b}MagicCX@{ub} will activate the window underneith the mouse after x ticks and only if the mouse isn`t moved anymore. @{b}*@{ub} @{b}Bring to front@{ub} Bring to front the activated window. @{b}*@{ub} @{b}Window reactivation@{ub} @{b}MagicCX@{ub} may remember an active window on a screen. As soon as you switch to a different screen, @{b}MagicCX@{ub} will reactivate the previously active window on the screen. @{b}*@{ub} @{b}Close window by key/Close key@{ub} If a window has a Close gadget attached, you normally have to click on the gadget in order to close the window. If you use "Close window by key" and "Close key", you may simulate the Close gadget click by hitting the "Close key" @EndNode @Node "ARexx" "MagicCX.guide/ARexx" @Next "AssignWedge" @Prev "Window related" @Toc "The Modules" The ARexx Port (including RCS module) ===================================== Per default @{b}MagicCX@{ub} doesn`t offer an ARexx Port. If you use this module, @{b}MagicCX@{ub} will be extended and can then be controlled through ARexx. Furthermore, you may retrieve settings from the ARexx module. If you have installed the RCS.mcxrxmod module, you may even use the Revision Control System from within ARexx (see @{"Revision Control System" Link "RCS"}, for more information), Here is a list of available ARexx commands @{" ACTIVATE " Link "ACTIVATE"} @{" AUTOLABEL " Link "AUTOLABEL"} @{" BILLPOPUP " Link "BILLPOPUP"} @{" DIRCACHE " Link "DIRCACHE"} @{" DISABLE " Link "DISABLE"} @{" DRIVE " Link "DRIVE"} @{" EJECT " Link "EJECT"} @{" ENABLE " Link "ENABLE"} @{" ESCCLOSE " Link "ESCCLOSE"} @{" FFS " Link "FFS"} @{" FKEYS " Link "FKEYS"} @{" FORMAT " Link "FORMAT"} @{" INSTALL " Link "INSTALL"} @{" INTERNATIONAL " Link "INTERNATIONAL"} @{" LABEL " Link "LABEL"} @{" LOGCALL " Link "LOGCALL"} @{" MAPUMLAUT " Link "MAPUMLAUT"} @{" MENUWRAP " Link "MENUWRAP"} @{" MOUSETIME " Link "MOUSETIME"} @{" NEXTCONNECT " Link "NEXTCONNECT"} @{" NEXTPAGE " Link "NEXTPAGE"} @{" NOVERIFY " Link "NOVERIFY"} @{" QUICK " Link "QUICK"} @{" REVISE " Link "REVISE"} @{" SCREENTIME " Link "SCREENTIME"} @{" SETENV " Link "SETENV"} @{" SUNMOUSE " Link "SUNMOUSE"} @{" TIMEZONE " Link "TIMEZONE"} @{" TRASHCAN " Link "TRASHCAN"} @{" WATCHDISKS " Link "WATCHDISKS"} @EndNode @Node "ACTIVATE" "MagicCX.guide/ACTIVATE" @Toc "ARexx" The ACTIVATE Command -------------------- @{b}Syntax:@{ub} ACTIVATE [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turn on/off Window activation in any form. This will enable/disable keystroke activation or SunMouse activation @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "AUTOLABEL" "MagicCX.guide/AUTOLABEL" @Toc "ARexx" The AUTOLABEL Command --------------------- @{b}Syntax:@{ub} AUTOLABEL [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turn Auto Labeling facility for Formatter on or off. If turned on, labels will be automatically numbered according to the number of formats done and to the highest possible auto label. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "BILLPOPUP" "MagicCX.guide/BILLPOPUP" @Toc "ARexx" The BILLPOPUP Command --------------------- @{b}Syntax:@{ub} BILLPOPUP [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Make the Bill Window popup if a new connect is encountered. If turned off, the Bill Window will only open up on demand. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "DIRCACHE" "MagicCX.guide/DIRCACHE" @Toc "ARexx" The DIRCACHE Command -------------------- @{b}Syntax:@{ub} DIRCACHE [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off Directory Caching for the Formatter. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "DISABLE" "MagicCX.guide/DISABLE" @Toc "ARexx" The DISABLE Command ------------------- @{b}Syntax:@{ub} DISABLE @{b}Argument template:@{ub} , @{b}Function:@{ub} Will disable MagicCX. Except for the clock(s) nothing more will work. MagicCX can be reactivated using CxExchange or the Enable ARexx command. @{b}Argument description:@{ub} - @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "DRIVE" "MagicCX.guide/DRIVE" @Toc "ARexx" The DRIVE Command ----------------- @{b}Syntax:@{ub} DRIVE [NUMBER]
@{b}Argument template:@{ub} NUMBER/N/A @{b}Function:@{ub} Set the drive a disk should be formatted in. Please specify the number of the drive you would like to use for the format. Numbers correspond to the drives connected to your Amiga, ie 0 for DF0:, 1 for DF1:, 2 for DF2:, and 3 for DF3: @{b}Argument description:@{ub} @{b}*@{ub} NUMBER
@{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "EJECT" "MagicCX.guide/EJECT" @Toc "ARexx" The EJECT Command ----------------- @{b}Syntax:@{ub} EJECT [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off the Eject feature of the Formatter. This one is available for Olaf Barthel`s formatter only. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "ENABLE" "MagicCX.guide/ENABLE" @Toc "ARexx" The ENABLE Command ------------------ @{b}Syntax:@{ub} ENABLE @{b}Argument template:@{ub} , @{b}Function:@{ub} Is the opposite to the DISABLE command. It will reenable all inactive features of MagicCX. All HotKeys and functions will be available again. This is the same as changing MagicCX`s state from within Commodities Exchange. @{b}Argument description:@{ub} - @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "ESCCLOSE" "MagicCX.guide/ESCCLOSE" @Toc "ARexx" The ESCCLOSE Command -------------------- @{b}Syntax:@{ub} ESCCLOSE [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off MagicCX window-close-by-key feature. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "FFS" "MagicCX.guide/FFS" @Toc "ARexx" The FFS Command --------------- @{b}Syntax:@{ub} FFS [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off FastFileSystem formatting for the Formatter. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "FKEYS" "MagicCX.guide/FKEYS" @Toc "ARexx" The FKEYS Command ----------------- @{b}Syntax:@{ub} FKEYS [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off Function Keys mapping of MagicCX. If turned on, you may use all of the defined Function Keys. If turned off the Function Keys will not be mapped by MagicCX. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "FORMAT" "MagicCX.guide/FORMAT" @Toc "ARexx" The FORMAT Command ------------------ @{b}Syntax:@{ub} FORMAT @{b}Argument template:@{ub} , @{b}Function:@{ub} Start the Formatter without opening MagicCX`s Formatting window. All settings for the Formatter made through previous calls of ARexx commands or from within the Formatter window will be used. @{b}Argument description:@{ub} - @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "INSTALL" "MagicCX.guide/INSTALL" @Toc "ARexx" The INSTALL Command ------------------- @{b}Syntax:@{ub} INSTALL [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off the Install feature of the Formatter. This one is available for Olaf Barthel`s formatter only. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "INTERNATIONAL" "MagicCX.guide/INTERNATIONAL" @Toc "ARexx" The INTERNATIONAL Command ------------------------- @{b}Syntax:@{ub} INTERNATIONAL [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off the International mode for the Formatter. This mode is only available under OS 3.x and up. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "LABEL" "MagicCX.guide/LABEL" @Toc "ARexx" The LABEL Command ----------------- @{b}Syntax:@{ub} LABEL [STRING] @{b}Argument template:@{ub} STRING/A @{b}Function:@{ub} Set the label for the following disk(s) to be formatted. @{b}Argument description:@{ub} @{b}*@{ub} STRING @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "LOGCALL" "MagicCX.guide/LOGCALL" @Toc "ARexx" The LOGCALL Command ------------------- @{b}Syntax:@{ub} LOGCALL [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} For the active connect, set the Save Log gadget. If turned off, no information about the connect will be saved to disk. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "MAPUMLAUT" "MagicCX.guide/MAPUMLAUT" @Toc "ARexx" The MAPUMLAUT Command --------------------- @{b}Syntax:@{ub} MAPUMLAUT [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off the Map Umlauts feature of MagicCX. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "MENUWRAP" "MagicCX.guide/MENUWRAP" @Toc "ARexx" The MENUWRAP Command -------------------- @{b}Syntax:@{ub} MENUWRAP [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off the MenuWrap feature of MagicCX. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "MOUSETIME" "MagicCX.guide/MOUSETIME" @Toc "ARexx" The MOUSETIME Command --------------------- @{b}Syntax:@{ub} MOUSETIME [TIME]
@{b}Argument template:@{ub} TIME/N/A @{b}Function:@{ub} For the mouse blanker. This command will set the timeout for the mouse blanker. @{b}Argument description:@{ub} @{b}*@{ub} TIME
Can be in the range from 1 (second) to 120 (seconds) @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "NEXTCONNECT" "MagicCX.guide/NEXTCONNECT" @Toc "ARexx" The NEXTCONNECT Command ----------------------- @{b}Syntax:@{ub} NEXTCONNECT @{b}Argument template:@{ub} , @{b}Function:@{ub} If there is more than one connect monitored by the PhoneBill module, this command will cause MagicCX to cycle to the next connect or restart in the list of connects. @{b}Argument description:@{ub} - @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "NEXTPAGE" "MagicCX.guide/NEXTPAGE" @Toc "ARexx" The NEXTPAGE Command -------------------- @{b}Syntax:@{ub} NEXTPAGE @{b}Argument template:@{ub} , @{b}Function:@{ub} This is for the clock page. Will cycle to the next (not excluded) page. @{b}Argument description:@{ub} - @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "NOVERIFY" "MagicCX.guide/NOVERIFY" @Toc "ARexx" The NOVERIFY Command -------------------- @{b}Syntax:@{ub} NOVERIFY [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off No Verify for the Formatter. This one is available for Olaf Barthel`s formatter only. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "QUICK" "MagicCX.guide/QUICK" @Toc "ARexx" The QUICK Command ----------------- @{b}Syntax:@{ub} QUICK [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off the Quick option for the formatter. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "REVISE" "MagicCX.guide/REVISE" @Toc "ARexx" The REVISE Command ------------------ @{b}Syntax:@{ub} REVISE > > [PUBSCREEN ] [INITIALVER
] [INITIALREV
] [INSERTBEFORE ] [INSERTAFTER ] @{b}Argument template:@{ub} FILE/K/A,MODE/K/A,PUBSCREEN/K,INITIALVER/K/N, INITIALREV/K/N,INSERTBEFORE/K,INSERTAFTER/K @{b}Function:@{ub} Invokes the Revision Control System. See the corresponding paragraphs for more information (see @{"Revision Control System" Link "RCS"}). @{b}Argument description:@{ub} @{b}*@{ub} FILE The file name of the file to be revised. @{b}*@{ub} MODE Which mode to use. Can be 'ASM', 'BAS', 'C' or 'PAS' @{b}*@{ub} PUBSCREEN The Public Screen`s name to open the window on @{b}*@{ub} INITIALVER
Initial version number. Only applicable for the initial revision @{b}*@{ub} INITIALREV
Initial revision number. Only applicable for the initial revision @{b}*@{ub} INSERTBEFORE File to insert before the header. Only applicable for the initial revision. @{b}*@{ub} INSERTAFTER File to insert after the header. Only applicable for the initial revision. @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "SCREENTIME" "MagicCX.guide/SCREENTIME" @Toc "ARexx" The SCREENTIME Command ---------------------- @{b}Syntax:@{ub} SCREENTIME [TIME]
@{b}Argument template:@{ub} TIME/N/A @{b}Function:@{ub} For the screen blanker. Will set the screen blanker`s timeout. @{b}Argument description:@{ub} @{b}*@{ub} TIME
Can be in the range of 1 (second) to 3600 (seconds) @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "SETENV" "MagicCX.guide/SETENV" @Toc "ARexx" The SETENV Command ------------------ @{b}Syntax:@{ub} SETENV [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off the clock`s Set ENV Vars feature. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "SUNMOUSE" "MagicCX.guide/SUNMOUSE" @Toc "ARexx" The SUNMOUSE Command -------------------- @{b}Syntax:@{ub} SUNMOUSE [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turns on/off the window activators SunMouse feature. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "TIMEZONE" "MagicCX.guide/TIMEZONE" @Toc "ARexx" The TIMEZONE Command -------------------- @{b}Syntax:@{ub} TIMEZONE [] @{b}Argument template:@{ub} ZONE/N @{b}Function:@{ub} For the current connect, set the timezone. @{b}Argument description:@{ub} @{b}*@{ub} ZONE Can be in the range of 1 to 5 @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "TRASHCAN" "MagicCX.guide/TRASHCAN" @Toc "ARexx" The TRASHCAN Command -------------------- @{b}Syntax:@{ub} TRASHCAN [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Turn on/off the Formatter`s Trashcan option. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "WATCHDISKS" "MagicCX.guide/WATCHDISKS" @Toc "ARexx" The WATCHDISKS Command ---------------------- @{b}Syntax:@{ub} WATCHDISKS [ON] [OFF] @{b}Argument template:@{ub} ON/S,OFF/S @{b}Function:@{ub} Tell MagicCX whether to monitor disks inserted into the drives. If turned ON, will cause MagicCX to monitor @{b}every@{ub} disk inserted whether to format the disk, or not. @{b}Argument description:@{ub} @{b}*@{ub} ON @{b}*@{ub} OFF @{b}Results:@{ub} - @{b}Note:@{ub} - @{b}Example:@{ub} - @EndNode @Node "AssignWedge" "MagicCX.guide/AssignWedge" @Next "UnixDirs" @Prev "ARexx" @Toc "The Modules" Better "Please insert..." requesters ==================================== You definitely know those requesters: "Please insert volume in any drive". Whoops, forgot to assign a directory? You would normally have to enter a Shell to do the assignment. Using this module you may either, Assign a directory, Mount a Device or even deny the process to get it`s assignment. If the system tries to open up a "Please..." requester, it is replaced by a new one with three more gadgets, which are: @{b}*@{ub} @{b}Assign...@{ub} Open a DirectoryRequester asking for a directory to assign the requested volume to @{b}*@{ub} @{b}Mount@{ub} Try to mount the specified device from DEVS:Mountlist @{b}*@{ub} @{b}Deny@{ub} Deny the request. As long as @{b}MagicCX@{ub} is running, the requesting application will not be satisfied to get the requested volume. No more requesters will be shown if the running application tries to access the volume again. @EndNode @Node "UnixDirs" "MagicCX.guide/UnixDirs" @Prev "AssignWedge" @Toc "The Modules" Use ".."/"." on your system =========================== Using this module you may use ".." and "." in a shell, just the way you probably know it from Unix systems. If you specify "." it refers to the current directory. ".." refers to the directory one level above the current one, so "../../" will get you two levels up. The "/" identifier which should bring you to the root level is not supported as it would conflict with AmigaDOS` own identifier. @EndNode @Node "RCS" "MagicCX.guide/RCS" @Prev "ARexx" @Toc "ARexx" The Revision Control System =========================== This really is a @{i}fine@{ui} feature. It might be interesting for the programmers of you, which are working on bigger, or even on smaller, projects. While working on a program it might be nice to see which changes were made to a program from this to that version. Inserting this data by hand is not quite that what I call simple. This is where @{b}MagicCX`s@{ub} @{i} Revision Control System@{ui} gets to work. This feature aids you in inserting good looking Revision headers directly into your sourcecode. All you have to do is to tell @{b}MagicCX@{ub} the program`s name to be revised, what kind of sourcecode it is and what information @{b}MagicCX@{ub} should insert into the Revision header. For the type of sourcecode you can choose between Assembler, Basic, `C', and Pascal/Modula. The main layout of the header is kept but only adjusted to perfectly fit into the desired type of sourcecode. The special thing about the function is the way it is called. The @{i} Revision Control System@{ui} can @{b}only@{ub} be called via ARexx. That is why I present the syntax for that call now: @{b}REVISE FILE=@{i}Filename@{ui} MODE=ASM|BAS|C|PAS PUBSCREEN=@{ub} @{b}INITIALVER=N INITIALREV=N INSERTBEFORE= INSERTAFTER=@{ub} As you can see all you have to do is to feed the function with the filename and an identifier for the type of sourcecode. The other options are optional and do not apply to every revision. Having started the @{i}Revision Control System@{ui} @{b}MagicCX@{ub} will first search the sourcecode whether there already is a Revision header inserted in the specified language. There is no need to position the header at the first line of the source. @{b}MagicCX@{ub} will search within the following lines to find the header, giving you the possibility to add specific directives in front of the header. So it is possible to insert text in front of the header(1). No matter if there already is a header this search will always be made when the @{i}Revision Control System@{ui} is called. From now on @{b}MagicCX@{ub} will go different paths in manipulating the source, depending on the existence of a header. @{b}MagicCX@{ub} comes with several ARexx scripts for use with the supported languages and for the CygnusED, TurboText, and GoldED editors. Using the "PUBSCREEN" keyword you may tell @{b}MagicCX@{ub} on which Public Screen to open the RCS window on. If the screen can not be found, @{b}MagicCX@{ub} will fall back to the default Public Screen. Make sure that the logical directory @{b}T:@{ub} is accessable, because @{b}MagicCX@{ub} needs that directory to temporarily store it`s work. To be secure I advise you to make a backup of your sourcecode before you start the @{i}Revision Control System@{ui}. (One can never know) After a Revision the RCS will either return 'TRUE' for success or 'FALSE' for failure. These return codes @{b}are@{ub} strings, so check your RESULT codes accordingly. If you want the program to store your name and the name of your `firm' within the header you will have to set two environment variables. @{b}*@{ub} @{b}AUTHOR@{ub} Set this variable to your name. @{b}*@{ub} @{b}COMPANY@{ub} Enter your firm`s name here. Now following is a small example for setting these variables: @{b}SETENV AUTHOR "Kai Iske"@{ub} @{b}SETENV COMPANY Gunthersoft@{ub} As you can see parameters which contain spaces have to be enclosed by quotes. Insert these settings within your @{b}s:User-StartUp@{ub} file to have the variables available on every bootup. @{" First revision " Link "FirstRev"} How to invoke the RCS the first time @{" Following revisions " Link "AgainRev"} Work on an already revised sourcecode @{" Special features " Link "RevSpec"} Special features and an example @{" Using RCS2HST " Link "Using RCS2HST"} Using the RCS2HST program ---------- Footnotes ---------- (1) Some Assemblers require special information within the first line of the source. @EndNode @Node "FirstRev" "MagicCX.guide/FirstRev" @Next "AgainRev" @Prev "RCS" @Toc "RCS" First revision of a sourcecode with the Revision Control System --------------------------------------------------------------- Assuming this situation I will now point out the actions @{b}MagicCX@{ub} performs when first used on a non-revised sourcecode. A window will be opened with the following title: @{b}Enter a Purpose Message@{ub} As the title says you are now to enter a purpose for the sourcecode you want to revise. You have the possibility to enter 5 lines and 60 chars per line. When you are done with the purpose message you can enter some more specific data. You can tell @{b}MagicCX@{ub} which version number to use for the first revision. This input is made within the integer gadgets at the bottom of the window. The "INITIALVER" and "INITIALREV" keywords for the RCS command are used to set the default Version/Revision for a new revision. Use these to preset the Integer gadgets. If you want to insert a header in front of the new header use the "INSERTBEFORE" keyword to specify the file to insert. To insert a header after the new header use the "INSERTAFTER" keyword and specify a file to insert. The integer gadget on the left is used to enter the version number. Into the right gadget you can enter the revision number. The gadgets @{b}OK@{ub} and @{b}CANCEL@{ub} are self-explanatory. Whilst @{b}OK@{ub} starts the revision @{b}CANCEL@{ub} is used to abort. Assuming that you have made all the input and started the @{i}Revision Control System@{ui} I will now describe the actions @{b}MagicCX@{ub} will perform for building the header. At first a part of the standard header will be built. The production will be made within @{b}T:@{ub}. If the environment variables are set the author`s and the `firm`s' name will be stored within the header. If @{b}MagicCX@{ub} was not able to find one variable, or even both of them, the corresponding fields will be set to `--- Unknown ---'. Furthermore the filename and the actual system date will be inserted. The current revision will be set to the value you specified or to the value @{b}MagicCX@{ub} automaticaly uses. Now the `purpose' text will be inserted and finally a `log message' for the current revision will be appended to the header. This log message will be set to `--- Initial release ---' for the first revision, because it is assumable that no changes have been made. Behind the log message @{b}MagicCX@{ub} will insert six macros, which reflect date of the revision, time of the revision, name of the author, who made the revision, the current revision number of the sourcecode and version/revision numbers. Please have a look at @{"The revision header`s special features" Link "RevSpec"}, for further information. The Revision header will be created at the start of the sourcecode, so you will have to insert lines which have to be in front of the header, after you revised the source. @EndNode @Node "AgainRev" "MagicCX.guide/AgainRev" @Next "RevSpec" @Prev "FirstRev" @Toc "RCS" Revision of an already revised sourcecode ----------------------------------------- If there already was a header within the sourcecode @{b}MagicCX@{ub} will now go the second way. Again a window will be opened which does not visually differ from the Purpose window. The window`s title is: @{b}Enter a Log Message@{ub} You can enter a descriptive text for all changes made to the source since the last release (Log message) here. The two integer gadgets at the bottom of the window can be used to set the new revision number @{b}MagicCX@{ub} should continue with. @{b}MagicCX@{ub} will automatically increment the revision of the sourcecode. @{b}MagicCX@{ub} will set the integer gadgets to the next revision. Say if the current revision is "1.1", the gadgets will read "1.2". You can now change the revision in case you want to skip several evolutionary steps. Selecting @{b}OK@{ub} you tell @{b}MagicCX@{ub} to continue whilst @{b}CANCEL@{ub} aborts the procedure. For additional revisions the "Only text" gadget is available. This gadget tells @{b}MagicCX@{ub} to @{b}add@{ub} the Log message to an already existing Log message, that means only text will be added, but no changes will be made to the revision number. Only the revision date will be changed. Did you tell @{b}MagicCX@{ub} to continue (using "Ok") only important entries will be changed within the header. The actual revision number will be set to the new value and the log message will be inserted before the previously entered. The log message`s header gives you information about the author of the revision and when the changes were made. Finally the macros behind the header will be recreated. For further information have a look at @{"The revision header`s special features" Link "RevSpec"}. The header`s postion within the source will be kept unchanged but the source`s length will slightly increase. If the first of the six macros could not be found right after the header, @{b}MagicCX@{ub} assumes that you no longer want the program to rebuild the macros and so it does not make a refresh. So if you insert a blank line between header and macros no more changes will be made to them. @EndNode @Node "RevSpec" "MagicCX.guide/RevSpec" @Next "Using RCS2HST" @Prev "AgainRev" @Toc "RCS" The revision header`s special features -------------------------------------- Here is a small example for the look of the header in Assembler. ; ; Header inserted or normal texts manually entered ; ;* $Revision Header built automatically *************** (do not edit) * ;* ;* Copyright by ;* ;* File : test ;* Created on : Monday, 22.02.93 17:50:35 ;* Created by : ;* Current revision : V2.5 ;* ;* ;* Purpose ;* ------- ;* - This is a test ;* ;* Revision V2.5 ;* -------------- ;* created on Monday, 22.02.93 17:50:41 by . LogMessage : ;* -*- changed on Monday, 22.02.93 17:50:57 by . LogMessage : ;* - Additional text for revision 2.5 ;* -*- created on Monday, 22.02.93 17:50:41 by . LogMessage : ;* - The next revision. This will be 2.5 ;* ;* Revision V1.0 ;* -------------- ;* created on Monday, 22.02.93 17:50:35 by . LogMessage : ;* --- Initial release --- ;* ;********************************************************************** REVISION MACRO dc.b "2.5" ENDM REVDATE MACRO dc.b "22.02.93" ENDM REVTIME MACRO dc.b "17:50:57" ENDM AUTHOR MACRO dc.b "" ENDM VERNUM EQU 2 REVNUM EQU 5 ; ; The "after" header and beginning of your sourcecode ; This is the header of an Assembler sourcecode which was revised once after it was created. The field will be filled with the name of the company (if present). The fields will be filled with the name of the author as long as the environment variable could be found. At the end of the header you find six macros. These macros reflect the actual revision number, date of revision, time of revision, the name of the author having done the revision and version/revision number. You can use these macros within your sourcecode, so that you can tell the user something about the program`s "evolution" during runtime. The Basic, `C' and Pascal/Modula pendants take the same names as in Assembler. The `C' type macros will be set as @{b}#defines@{ub} into the sourcecode. As you might believe the Basic "@{i}versions@{ui}" are string variables which have a @{b}$@{ub} postpended. There is one thing to remember while using the Pascal/Modula macros: To make these macros available within sourcecodes I chose the possibility to declare the macros as @{b}CONST@{ub}ants. Therefore the @{b}CONST@{ub} symbol will immediatly follow the header and then following are the macros. So you will have to add any other constant declarations @{b}after@{ub} @{b}MagicCX`s@{ub}. @EndNode @Node "Using RCS2HST" "MagicCX.guide/Using RCS2HST" @Prev "RevSpec" @Toc "RCS" Using the RCS2HST program ------------------------- Normally, you will insert your revision headers directly into one or all of your source files. If you want to distribute a History or Changes file with you application, you normally have to cut out the header and place it in a seperate file, edit it and style it a bit to suit your needs. If you simply want to extract the revision information and write it to a simple changes file you may use the RCS2HST utility. When running RCS2HST from a Shell, simply supply the name of the file containing the header and the name of the file you want to write the changes to. This file will always be recreated when using RCS2HST again on the changes file. From Workbench, simply double-click on it`s icon. RCS2HST will then ask for the input file using a FileRequester and then for the output file, again using the FileRequester. Any errors during conversion will be reported. @EndNode @Node "Legal things" "MagicCX.guide/Legal things" @Next "Registration" @Prev "The Modules" @Toc "Main" Legal things ************ @{" Licence " Link "Licence"} @{" Warranty " Link "Warranty"} @{" Copyright " Link "Copyright"} @EndNode @Node "Licence" "MagicCX.guide/Licence" @Next "Warranty" @Prev "Legal things" @Toc "Legal things" Licence ======= 1. This licence applies to the product called @{b}MagicCX@{ub}, a package for the @{b}AMIGA@{ub} computer, published by Kai Iske under the concepts of @{b}Shareware@{ub}. The terms "Package", "@{b}MagicCX@{ub}" and "Archive" refer to this product. The licensee is addressed as "you". This license does not apply to third party supplied programs, found e.g. in the @{b}c@{ub} or @{b}libs@{ub} drawer of the original distribution archive. 2. You may use @{b}MagicCX@{ub} for a period of up to 21 days for evaluation. After that, you have to register. 3. This archive may be freely redistributed @{b}without the keyfile@{ub} only, which you got from me when you have registered. Please remember that the keyfile contains your name to prevent you from giving it away to others. 4. You are @{b}not allowed@{ub} to draw commercial profit out of distributing this package. You may charge a fee to recover distribution and copy costs. The fee for diskette distribution may @{b}not be more@{ub} than the cost to obtain a public domain diskette from Fred Fish. 5. You are @{b}not@{ub} allowed to manipulate any file of @{b}MagicCX@{ub} and distribute it under any or no name. Compression with common archivers like @{b}zoo@{ub} or @{b}lharc@{ub} is allowed. You are only allowed to redistribute the @{b}whole@{ub} original archive (@{b}without@{ub} the keyfile however). 6. Some files @{b}may be@{ub} modified for your personal use: @{b}*@{ub} The AREXX scripts The example AREXX scripts which can be found in the @{b}Rexx@{ub} drawer of the original distribution may be modified and/or enhanced. @{b}*@{ub} The LOCALE files If you adopt the catalog translation files (extension @{b}.ct@{ub}), you will be able to translate all program texts of @{b}MagicCX@{ub} into your native language. If you do such changes, you may do so for your personal use; redistribution of modified files is not allowed. (Nevertheless the author would be happy, if you'd sent him your modified files, so that they may serve as a basis for an inclusion into future versions of @{b}MagicCX@{ub}) 7. If developers of commercial software would like to include certain parts of @{b}MagicCX@{ub} in their commercial products, they will have to contact the author of @{b}MagicCX@{ub} first, to ask for permission. 8. You agree to cease distributing @{b}MagicCX@{ub} if requested to do so by the author. 9. By copying, distributing and/or using @{b}MagicCX@{ub} you indicate your acceptance of this license to do so, and all its terms and conditions. 10. Each time you redistribute this package, the recipient automatically receives a license from the original licensor to copy, distribute and/or use this package subject to these terms and conditions. @{b}You may not impose any further restrictions on the recipients' exercise of the rights granted herin@{ub}. 11. As always, Fred Fish has got explicit permission to include this package into his wonderful "Fish Disk" collection, no matter if it is on floppy or compact disk. @EndNode @Node "Warranty" "MagicCX.guide/Warranty" @Next "Copyright" @Prev "Licence" @Toc "Legal things" Warranty ======== This software is provided @{b}as is@{ub} without warranty of any kind, either expressed or implied. By using @{b}MagicCX@{ub}, you agree to accept the entire risk as to the quality and performance of this package. In no event (unless required by applicable law or agreed to in writing) will any copyright holder, or any other party who may redistribute this package as permitted above, be liable to you for damages, including any general, special, incidential or consequential damages arising out of the use or inability to use this package (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties), even if such holder or other party has been advised of the possibility of such damages. Of course, @{b}MagicCX@{ub} has been tested rather extensively before it was released. In case you find any bugs in @{b}MagicCX@{ub} I please you to send me a bug report. See @{"Bugreports" Link "Bugreports"}. @EndNode @Node "Copyright" "MagicCX.guide/Copyright" @Prev "Warranty" @Toc "Legal things" Copyright ========= MagicCX is (C) Copyright 1994 Kai Iske, ShareWare The MagicWB icons are (C) Copyright 1993-94 Martin Huttenloher Amiga is copyrighted by Commodore Business Machines Installer and Installer project icon (c) Copyright 1991-93 Commodore-Amiga, Inc. All Rights Reserved. Reproduced and distributed under license from Commodore. INSTALLER SOFTWARE IS PROVIDED "AS-IS" AND SUBJECT TO CHANGE; NO WARRANTIES ARE MADE. ALL USE IS AT YOUR OWN RISK. NO LIABILITY OR RESPONSIBILITY IS ASSUMED. ReqTools is (C) Copyright Nico Francois Registered trademarks are @{b}not@{ub} marked separately. Therefore absence of a trademark does not imply they are free. @EndNode @Node "Registration" "MagicCX.guide/Registration" @Next "Updates" @Prev "Legal things" @Toc "Main" Registration ************ Since Version 1.0 of @{b}MagicCX@{ub} has been finished, it is a product with the @{b}SASG@{ub} quality brand. The advantages, which grow out of this can be looked up within the @{"Registration/Information " system MagicCX:Tools/Register} program. Information about registration sites, the @{b}SASG@{ub}, the shareware fee, payment methods etc. can be found there as well. The registration program can be started either seperately or directly out of the about requester of @{b}MagicCX@{ub}. Before you register, you have the opportunity to test @{b}MagicCX@{ub} in great detail. However, when using the unregistered version you can't save the preferences (this feature is disabled); all changes you perform using the @{b}MagicCX Preferences@{ub} program stay active only until you reboot your computer. In spite of all this restrictions it should be possible to see if @{b}MagicCX@{ub} is what you expect. As soon as you use @{b}MagicCX@{ub} regularly, however not later than after 21 days, you have to register! You'll get your personal keyfile, a TeX manual (in German @{b}and@{ub} English) and an AMIGAGUIDE manual (German @{b}and@{ub} English). All manual files are on the disk only and @{b}not@{ub} printed! For major updates, you will have to update in order to get a new keyfile which unlocks the new features of the new version. Major updates will be marked as such so for normal (minor) updates you @{b}do not@{ub} have to update/pay. All features of minor updates will be unlocked through your old key. Please don`t think that I will release major updates every month or so. Major updates will only show up once or (maximum) twice a year, depending on development, ie. it might be that there won`t be any major update which, of course, means you don`t have to pay. I will, again of course, continue developing @{b}MagicCX@{ub} which will result in some minor updates, depending on the need of users. You'll find my address below, See @{"Important addresses" Link "Important addresses"}. @EndNode @Node "Updates" "MagicCX.guide/Updates" @Next "Bugreports" @Prev "Registration" @Toc "Main" Updates ******* I'm continously working on @{b}MagicCX@{ub} and I'll publish small updates from time to time. These updates will be fed into the following electronic nets: @{b}*@{ub} @{b}ADS Filenet@{ub} @{b}*@{ub} @{b}AmiNet FTP Servers@{ub} @{b}*@{ub} @{b}FRAS Net (only available in Germany)@{ub} If you have access to such an electronic net, you can get the latest version of @{b}MagicCX@{ub} quickly and cheaply. Many electronic mailboxes supply the latest version of @{b}MagicCX@{ub} as well, e.g. @{b}Publisher's Treff@{ub} 63739 Aschaffenburg Tel.: Germany-(0)6021-93435 Fido: 2:244/6302.0 Alternatively you may order your update directly from me. Please use the registration program for this purpose - as you've already done when you've registered. Fred Fish will get @{b}MagicCX@{ub} to include it in his library. However, it will last a few weeks until @{b}MagicCX@{ub} finds its was on these floppy or compact disks respectively. @EndNode @Node "Bugreports" "MagicCX.guide/Bugreports" @Next "Important addresses" @Prev "Updates" @Toc "Main" Bugreports ********** I ask you to report any bugs you discover. If you have any ideas what should be improved in future versions of @{b}MagicCX@{ub}, please feel free to write, (mail or email, doesn't matter) giving me any suggestions. Bug reports can be sent by ordinary or elecronic mail. The address can be found in @{"Important addresses" Link "Important addresses"}. @EndNode @Node "Important addresses" "MagicCX.guide/Important addresses" @Next "Internals" @Prev "Bugreports" @Toc "Main" Important addresses ******************* @{" The author`s address " Link "The author`s address"} @{" Frank Mariak`s address " Link "Frank Mariak`s address"} @{" Registration Site Australia " Link "Registration Site Australia"} @{" Registration Site England " Link "Registration Site England"} @{" Registration Site USA " Link "Registration Site USA"} @EndNode @Node "The author`s address" "MagicCX.guide/The author`s address" @Next "Frank Mariak`s address" @Prev "Important addresses" @Toc "Important addresses" The author`s address ==================== If you have any questions, suggestions, bug reports or anything else you want to tell me, you can contact me under one of the addresses. Either use normal snail mail: Kai Iske Brucknerstrasse 18 63452 Hanau Germany Tel.: +49-(0)6181-850181 or reach me using electronical mail INTERNET: iske@informatik.uni-frankfurt.de USENET: kai@iske.adsp.sub.org FIDO: Kai Iske, 2:244/6302.11 ZNET: KAI@SWEET.RHEIN.MAIN.DE @EndNode @Node "Frank Mariak`s address" "MagicCX.guide/Frank Mariak`s address" @Next "Registration Site Australia" @Prev "The author`s address" @Toc "Important addresses" Frank Mariak`s address ====================== Frank did all of the blanker modules. If you have any bugreportes, suggestions regarding the blanker modules @{b}please@{ub} contact him! Either use normal snail mail: Frank Mariak Eyller Stra e 180 47475 Kamp-Lintfort Germany Tel.: +49-(0)2842-7270 or reach him using electronical mail INTERNET: hl936ma@unidui.uni-duisburg.de (This is addresse might change soon) @EndNode @Node "Registration Site Australia" "MagicCX.guide/Registration Site Australia" @Next "Registration Site England" @Prev "Frank Mariak`s address" @Toc "Important addresses" Registration Site Australia =========================== @{b}Continental Drift BBS@{ub} PO Box 259 Newport Beach NSW 2106 Australia @{b}E-Mail:@{ub} UUCP: @{b}swreg@drift.apana.org.au@{ub} @EndNode @Node "Registration Site England" "MagicCX.guide/Registration Site England" @Next "Registration Site USA" @Prev "Registration Site Australia" @Toc "Important addresses" Registration Site England ========================= @{b}Paul Jewell@{ub} 7 Fairfield Avenue Victoria Park Cardiff Great Britain (Wales) @{b}E-Mail:@{ub} UUCP: @{b}jewell@savanna.exnet.com@{ub} @EndNode @Node "Registration Site USA" "MagicCX.guide/Registration Site USA" @Prev "Registration Site England" @Toc "Important addresses" Registration Site USA ===================== @{b}Robert Blayzor@{ub} PO Box 807 Johnstown, NY 12095-0807 U.S.A. @{b}E-Mail@{ub} UUCP: @{b}die@lsd.org@{ub} @EndNode @Node "Internals" "MagicCX.guide/Internals" @Next "Configuration requirements" @Prev "Important addresses" @Toc "Main" Internals ********* With @{b}MagicCX@{ub} you get the program`s locale source files. If you like to create new program texts in a different language, please use the files located in @{b}MagicCX:Locale/LocaleSource.lha@{ub}. There you will find the source files for all the catalogs. If you have created a new catalog file for a language not yet supported, please let me know and I will incorporate it in @{b}MagicCX`s@{ub} distribution. @EndNode @Node "Configuration requirements" "MagicCX.guide/Configuration requirements" @Next "Some hints" @Prev "Internals" @Toc "Main" Configuration requirements ************************** The minimum configuration for the usage of @{b}MagicCX@{ub} consists of any @{b}AMIGA@{ub} computer that runs at least @{b}AMIGA-OS 2.0@{ub} and 1 MB RAM. As the modules are completely kept in RAM, when loaded, as more you have the better it is. A harddisk is not needed, but recommended. If you run version 3.x of the operating system, you can enjoy some additional (mostly optical) features of this OS version, including the Modules Manager (see @{"Modules Manager" Link "Modules Manager"}). @EndNode @Node "Some hints" "MagicCX.guide/Some hints" @Next "Thanks-Credits" @Prev "Configuration requirements" @Toc "Main" Some hints for usage... *********************** @{b}Question:@{ub} After I restarted the computer, @{b}MagicCX@{ub} has "forgotten" all settings I'd adjusted before - why? @{b}@{b}Answer:@{ub}@{ub} To save the settings, you have to save the @{b}MagicCX@{ub} preferences. This can be done by selecting the appropriate gadget of the Preferences program. Please remember that the settings and as a consequence of this the window positions as well, can only be saved in the registered version of @{b}MagicCX@{ub} (see @{"Registration" Link "Registration"}, for details). @EndNode @Node "Thanks-Credits" "MagicCX.guide/Thanks-Credits" @Prev "Some hints" @Toc "Main" Thanks must go to... ******************** I would like to thank the following people @{b}*@{ub} @{b}My betatester@{ub} Dirk Federlein, Stefan Stuntz, Martin 'XEN' Huttenloher, Bernhard Moellemann, Martin Korndoerfer, Klaus 'kmel' Melchior, Andreas 'Goonie' Schildbach, Michael 'Mick' Hohmann, Fionn Behrens, Lars Eilebrecht, Henning Schmiedehausen, Frank Mariak, Andreas Goiczyk, Andreas Otte, Ralf Deifel @{b}*@{ub} @{b}Frank Mariak@{ub} For betatesting and the blanker modules @{b}*@{ub} @{b}Olaf Barthel@{ub} Who answered some questions and helped me with some problems. Furthermore many thanks for the layout engine. @{b}*@{ub} @{b}Christoph Reichert@{ub} My FIDO-Boss for the support @{b}*@{ub} @{b}My girlfriend@{ub} Who accepts what I`ve done/doing ...and all the others I forgot @EndNode